<p>This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer for the application proxy inside your account.
", + "CreateEnvironment": "Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and they are referred to as the environment owner. The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with. When creating an environment, Refactor Spaces provisions a transit gateway in your account.
", + "CreateRoute": "Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.
When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:
If the service has a URL endpoint, and the endpoint resolves to a private IP address, Refactor Spaces routes traffic using the API Gateway VPC link.
If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
If the service has an Lambda function endpoint, then Refactor Spaces uses the API Gateway Lambda integration.
A health check is performed on the service when the route is created. If the health check fails, the route transitions to FAILED, and no traffic is sent to the service.
For Lambda functions, the Lambda function state is checked. If the function is not active, the function configuration is updated so that Lambda resources are provisioned. If the Lambda state is Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.
For public URLs, a connection is opened to the public endpoint. If the URL is not reachable, the health check fails. For private URLs, a target group is created and the target group health check is run.
The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same protocol, port, and path specified in the URL or health URL, if used. All other settings use the default values, as described in Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.
Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.
If an Amazon Web Services resourceis launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.
Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.
", + "DeleteEnvironment": "Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.
", + "DeleteResourcePolicy": "Deletes the resource policy set for the environment.
", + "DeleteRoute": "Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
", + "DeleteService": "Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
", + "GetApplication": "Gets an Amazon Web Services Migration Hub Refactor Spaces application.
", + "GetEnvironment": "Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
", + "GetResourcePolicy": "Gets the resource-based permission policy that is set for the given environment.
", + "GetRoute": "Gets an Amazon Web Services Migration Hub Refactor Spaces route.
", + "GetService": "Gets an Amazon Web Services Migration Hub Refactor Spaces service.
", + "ListApplications": "Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
", + "ListEnvironmentVpcs": "Lists all the virtual private clouds (VPCs) that are part of an Amazon Web Services Migration Hub Refactor Spaces environment.
", + "ListEnvironments": "Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
", + "ListRoutes": "Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
", + "ListServices": "Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
", + "ListTagsForResource": "Lists the tags of a resource. The caller account must be the same as the resource’s OwnerAccountId. Listing tags in other accounts is not supported.
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.
Removes the tags of a given resource. Tags are metadata which can be used to manage a resource. To tag a resource, the caller account must be the same as the resource’s OwnerAccountId. Tagging resources in other accounts is not supported.
Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. To untag a resource, the caller account must be the same as the resource’s OwnerAccountId. Untagging resources across accounts is not supported.
The user does not have sufficient access to perform this action.
", + "refs": { + } + }, + "AccountId": { + "base": null, + "refs": { + "ApplicationSummary$CreatedByAccountId": "The Amazon Web Services account ID of the application creator.
", + "ApplicationSummary$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "CreateApplicationResponse$CreatedByAccountId": "The Amazon Web Services account ID of application creator.
", + "CreateApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "CreateEnvironmentResponse$OwnerAccountId": "The Amazon Web Services account ID of environment owner.
", + "CreateRouteResponse$CreatedByAccountId": "The Amazon Web Services account ID of the route creator.
", + "CreateRouteResponse$OwnerAccountId": "The Amazon Web Services account ID of the route owner.
", + "CreateServiceResponse$CreatedByAccountId": "The Amazon Web Services account ID of the service creator.
", + "CreateServiceResponse$OwnerAccountId": "The Amazon Web Services account ID of the service owner.
", + "EnvironmentSummary$OwnerAccountId": "The Amazon Web Services account ID of the environment owner.
", + "EnvironmentVpc$AccountId": "The Amazon Web Services account ID of the virtual private cloud (VPC) owner.
", + "ErrorResponse$AccountId": "The Amazon Web Services account ID of the resource owner.
", + "GetApplicationResponse$CreatedByAccountId": "The Amazon Web Services account ID of the application creator.
", + "GetApplicationResponse$OwnerAccountId": "The Amazon Web Services account ID of the application owner.
", + "GetEnvironmentResponse$OwnerAccountId": "The Amazon Web Services account ID of the environment owner.
", + "GetRouteResponse$CreatedByAccountId": "The Amazon Web Services account ID of the route creator.
", + "GetRouteResponse$OwnerAccountId": "The Amazon Web Services account ID of the route owner.
", + "GetServiceResponse$CreatedByAccountId": "The Amazon Web Services account ID of the service creator.
", + "GetServiceResponse$OwnerAccountId": "The Amazon Web Services account ID of the service owner.
", + "RouteSummary$CreatedByAccountId": "The Amazon Web Services account ID of the route creator.
", + "RouteSummary$OwnerAccountId": "The Amazon Web Services account ID of the route owner.
", + "ServiceSummary$CreatedByAccountId": "The Amazon Web Services account ID of the service creator.
", + "ServiceSummary$OwnerAccountId": "The Amazon Web Services account ID of the service owner.
" + } + }, + "AdditionalDetails": { + "base": null, + "refs": { + "ErrorResponse$AdditionalDetails": "Additional details about the error.
" + } + }, + "AdditionalDetailsKey": { + "base": null, + "refs": { + "AdditionalDetails$key": null + } + }, + "AdditionalDetailsValue": { + "base": null, + "refs": { + "AdditionalDetails$value": null + } + }, + "ApiGatewayEndpointType": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$EndpointType": "The type of API Gateway endpoint created.
", + "ApiGatewayProxyInput$EndpointType": "The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.
If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.
The type of API Gateway endpoint created.
" + } + }, + "ApiGatewayId": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$ApiGatewayId": "The resource ID of the API Gateway for the proxy.
", + "ApiGatewayProxySummary$ApiGatewayId": "The resource ID of the API Gateway for the proxy.
" + } + }, + "ApiGatewayProxyConfig": { + "base": "A wrapper object holding the Amazon API Gateway proxy configuration.
", + "refs": { + "GetApplicationResponse$ApiGatewayProxy": "The endpoint URL of the API Gateway proxy.
" + } + }, + "ApiGatewayProxyInput": { + "base": "A wrapper object holding the Amazon API Gateway endpoint input.
", + "refs": { + "CreateApplicationRequest$ApiGatewayProxy": "A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
", + "CreateApplicationResponse$ApiGatewayProxy": "A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
" + } + }, + "ApiGatewayProxySummary": { + "base": "A wrapper object holding the Amazon API Gateway proxy summary.
", + "refs": { + "ApplicationSummary$ApiGatewayProxy": "The endpoint URL of the Amazon API Gateway proxy.
" + } + }, + "ApplicationId": { + "base": null, + "refs": { + "ApplicationSummary$ApplicationId": "The unique identifier of the application.
", + "CreateApplicationResponse$ApplicationId": "The unique identifier of the application.
", + "CreateRouteRequest$ApplicationIdentifier": "The ID of the application within which the route is being created.
", + "CreateRouteResponse$ApplicationId": "The ID of the application in which the route is created.
", + "CreateServiceRequest$ApplicationIdentifier": "The ID of the application which the service is created.
", + "CreateServiceResponse$ApplicationId": "The ID of the application that the created service belongs to.
", + "DeleteApplicationRequest$ApplicationIdentifier": "The ID of the application.
", + "DeleteApplicationResponse$ApplicationId": "The ID of the application.
", + "DeleteRouteRequest$ApplicationIdentifier": "The ID of the application to delete the route from.
", + "DeleteRouteResponse$ApplicationId": "he ID of the application that the route belongs to.
", + "DeleteServiceRequest$ApplicationIdentifier": "Deletes a Refactor Spaces service.
The RefactorSpacesSecurityGroup security group must be removed from all Amazon Web Services resources in the virtual private cloud (VPC) prior to deleting a service with a URL endpoint in a VPC.
The ID of the application that the service is in.
", + "GetApplicationRequest$ApplicationIdentifier": "The ID of the application.
", + "GetApplicationResponse$ApplicationId": "The unique identifier of the application.
", + "GetRouteRequest$ApplicationIdentifier": "The ID of the application.
", + "GetRouteResponse$ApplicationId": "The ID of the application that the route belongs to.
", + "GetServiceRequest$ApplicationIdentifier": "The ID of the application.
", + "GetServiceResponse$ApplicationId": "The ID of the application.
", + "ListRoutesRequest$ApplicationIdentifier": "The ID of the application.
", + "ListServicesRequest$ApplicationIdentifier": "The ID of the application.
", + "RouteSummary$ApplicationId": "The unique identifier of the application.
", + "ServiceSummary$ApplicationId": "The unique identifier of the application.
" + } + }, + "ApplicationName": { + "base": null, + "refs": { + "ApplicationSummary$Name": "The name of the application.
", + "CreateApplicationRequest$Name": "The name to use for the application.
", + "CreateApplicationResponse$Name": "The name of the application.
", + "DeleteApplicationResponse$Name": "The name of the application.
", + "GetApplicationResponse$Name": "The name of the application.
" + } + }, + "ApplicationState": { + "base": null, + "refs": { + "ApplicationSummary$State": "The current state of the application.
", + "CreateApplicationResponse$State": "The current state of the application.
", + "DeleteApplicationResponse$State": "The current state of the application.
", + "GetApplicationResponse$State": "The current state of the application.
" + } + }, + "ApplicationSummaries": { + "base": null, + "refs": { + "ListApplicationsResponse$ApplicationSummaryList": "The list of ApplicationSummary objects.
The list of ApplicationSummary objects.
Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.
Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.
Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.
The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
" + } + }, + "ClientToken": { + "base": null, + "refs": { + "CreateApplicationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateEnvironmentRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateRouteRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateServiceRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" + } + }, + "ConflictException": { + "base": "Updating or deleting a resource can cause an inconsistent state.
", + "refs": { + } + }, + "CreateApplicationRequest": { + "base": null, + "refs": { + } + }, + "CreateApplicationResponse": { + "base": null, + "refs": { + } + }, + "CreateEnvironmentRequest": { + "base": null, + "refs": { + } + }, + "CreateEnvironmentResponse": { + "base": null, + "refs": { + } + }, + "CreateRouteRequest": { + "base": null, + "refs": { + } + }, + "CreateRouteResponse": { + "base": null, + "refs": { + } + }, + "CreateServiceRequest": { + "base": null, + "refs": { + } + }, + "CreateServiceResponse": { + "base": null, + "refs": { + } + }, + "DeleteApplicationRequest": { + "base": null, + "refs": { + } + }, + "DeleteApplicationResponse": { + "base": null, + "refs": { + } + }, + "DeleteEnvironmentRequest": { + "base": null, + "refs": { + } + }, + "DeleteEnvironmentResponse": { + "base": null, + "refs": { + } + }, + "DeleteResourcePolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteResourcePolicyResponse": { + "base": null, + "refs": { + } + }, + "DeleteRouteRequest": { + "base": null, + "refs": { + } + }, + "DeleteRouteResponse": { + "base": null, + "refs": { + } + }, + "DeleteServiceRequest": { + "base": null, + "refs": { + } + }, + "DeleteServiceResponse": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "CreateEnvironmentRequest$Description": "The description of the environment.
", + "CreateEnvironmentResponse$Description": "A description of the environment.
", + "CreateServiceRequest$Description": "The description of the service.
", + "CreateServiceResponse$Description": "The description of the created service.
", + "EnvironmentSummary$Description": "A description of the environment.
", + "GetEnvironmentResponse$Description": "The description of the environment.
", + "GetServiceResponse$Description": "The description of the service.
", + "ServiceSummary$Description": "A description of the service.
" + } + }, + "Ec2TagValue": { + "base": null, + "refs": { + "EnvironmentVpc$VpcName": "The name of the VPC at the time it is added to the environment.
" + } + }, + "EnvironmentId": { + "base": null, + "refs": { + "ApplicationSummary$EnvironmentId": "The unique identifier of the environment.
", + "CreateApplicationRequest$EnvironmentIdentifier": "The unique identifier of the environment.
", + "CreateApplicationResponse$EnvironmentId": "The ID of the environment in which the application is created.
", + "CreateEnvironmentResponse$EnvironmentId": "The unique identifier of the environment.
", + "CreateRouteRequest$EnvironmentIdentifier": "The ID of the environment in which the route is created.
", + "CreateServiceRequest$EnvironmentIdentifier": "The ID of the environment in which the service is created.
", + "CreateServiceResponse$EnvironmentId": "The unique identifier of the environment.
", + "DeleteApplicationRequest$EnvironmentIdentifier": "The ID of the environment.
", + "DeleteApplicationResponse$EnvironmentId": "The unique identifier of the application’s environment.
", + "DeleteEnvironmentRequest$EnvironmentIdentifier": "The ID of the environment.
", + "DeleteEnvironmentResponse$EnvironmentId": "The unique identifier of the environment.
", + "DeleteRouteRequest$EnvironmentIdentifier": "The ID of the environment to delete the route from.
", + "DeleteServiceRequest$EnvironmentIdentifier": "The ID of the environment that the service is in.
", + "DeleteServiceResponse$EnvironmentId": "The unique identifier of the environment.
", + "EnvironmentSummary$EnvironmentId": "The unique identifier of the environment.
", + "EnvironmentVpc$EnvironmentId": "The unique identifier of the environment.
", + "GetApplicationRequest$EnvironmentIdentifier": "The ID of the environment.
", + "GetApplicationResponse$EnvironmentId": "The unique identifier of the environment.
", + "GetEnvironmentRequest$EnvironmentIdentifier": "The ID of the environment.
", + "GetEnvironmentResponse$EnvironmentId": "The unique identifier of the environment.
", + "GetRouteRequest$EnvironmentIdentifier": "The ID of the environment.
", + "GetRouteResponse$EnvironmentId": "Unique identifier of the environment.
", + "GetServiceRequest$EnvironmentIdentifier": "The ID of the environment.
", + "GetServiceResponse$EnvironmentId": "The unique identifier of the environment.
", + "ListApplicationsRequest$EnvironmentIdentifier": "The ID of the environment.
", + "ListEnvironmentVpcsRequest$EnvironmentIdentifier": "The ID of the environment.
", + "ListRoutesRequest$EnvironmentIdentifier": "The ID of the environment.
", + "ListServicesRequest$EnvironmentIdentifier": "The ID of the environment.
", + "RouteSummary$EnvironmentId": "The unique identifier of the environment.
", + "ServiceSummary$EnvironmentId": "The unique identifier of the environment.
" + } + }, + "EnvironmentName": { + "base": null, + "refs": { + "CreateEnvironmentRequest$Name": "The name of the environment.
", + "CreateEnvironmentResponse$Name": "The name of the environment.
", + "DeleteEnvironmentResponse$Name": "The name of the environment.
", + "EnvironmentSummary$Name": "The name of the environment.
", + "GetEnvironmentResponse$Name": "The name of the environment.
" + } + }, + "EnvironmentState": { + "base": null, + "refs": { + "CreateEnvironmentResponse$State": "The current state of the environment.
", + "DeleteEnvironmentResponse$State": "The current state of the environment.
", + "EnvironmentSummary$State": "The current state of the environment.
", + "GetEnvironmentResponse$State": "The current state of the environment.
" + } + }, + "EnvironmentSummaries": { + "base": null, + "refs": { + "ListEnvironmentsResponse$EnvironmentSummaryList": "The list of EnvironmentSummary objects.
The summary information for environments as a response to ListEnvironments.
Provides summary information for the EnvironmentVpc resource as a response to ListEnvironmentVpc.
The list of EnvironmentVpc objects.
The error code associated with the error.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ErrorResponse$Message": "The message associated with the error.
" + } + }, + "ErrorResourceType": { + "base": null, + "refs": { + "ErrorResponse$ResourceType": "The type of resource.
" + } + }, + "ErrorResponse": { + "base": "Error associated with a resource returned for a Get or List resource response.
", + "refs": { + "ApplicationSummary$Error": "Any error associated with the application resource.
", + "EnvironmentSummary$Error": "Any error associated with the environment resource.
", + "GetApplicationResponse$Error": "Any error associated with the application resource.
", + "GetEnvironmentResponse$Error": "Any error associated with the environment resource.
", + "GetRouteResponse$Error": "Any error associated with the route resource.
", + "GetServiceResponse$Error": "Any error associated with the service resource.
", + "RouteSummary$Error": "Any error associated with the route resource.
", + "ServiceSummary$Error": "Any error associated with the service resource.
" + } + }, + "GetApplicationRequest": { + "base": null, + "refs": { + } + }, + "GetApplicationResponse": { + "base": null, + "refs": { + } + }, + "GetEnvironmentRequest": { + "base": null, + "refs": { + } + }, + "GetEnvironmentResponse": { + "base": null, + "refs": { + } + }, + "GetResourcePolicyRequest": { + "base": null, + "refs": { + } + }, + "GetResourcePolicyResponse": { + "base": null, + "refs": { + } + }, + "GetRouteRequest": { + "base": null, + "refs": { + } + }, + "GetRouteResponse": { + "base": null, + "refs": { + } + }, + "GetServiceRequest": { + "base": null, + "refs": { + } + }, + "GetServiceResponse": { + "base": null, + "refs": { + } + }, + "HttpMethod": { + "base": null, + "refs": { + "HttpMethods$member": null + } + }, + "HttpMethods": { + "base": null, + "refs": { + "GetRouteResponse$Methods": "A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
", + "RouteSummary$Methods": "A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
", + "UriPathRouteInput$Methods": "A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.
" + } + }, + "InternalServerException": { + "base": "An unexpected error occurred while processing the request.
", + "refs": { + } + }, + "InvalidResourcePolicyException": { + "base": "The resource policy is not valid.
", + "refs": { + } + }, + "LambdaArn": { + "base": null, + "refs": { + "LambdaEndpointConfig$Arn": "The Amazon Resource Name (ARN) of the Lambda endpoint.
", + "LambdaEndpointInput$Arn": "The Amazon Resource Name (ARN) of the Lambda endpoint.
", + "LambdaEndpointSummary$Arn": "The Amazon Resource Name (ARN) of the Lambda endpoint.
" + } + }, + "LambdaEndpointConfig": { + "base": "The configuration for the Lambda endpoint type.
", + "refs": { + "GetServiceResponse$LambdaEndpoint": "The configuration for the Lambda endpoint type.
The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.
" + } + }, + "LambdaEndpointInput": { + "base": "The input for the Lambda endpoint type.
", + "refs": { + "CreateServiceRequest$LambdaEndpoint": "The configuration for the Lambda endpoint type.
", + "CreateServiceResponse$LambdaEndpoint": "The configuration for the Lambda endpoint type.
" + } + }, + "LambdaEndpointSummary": { + "base": "The summary for the Lambda endpoint type.
", + "refs": { + "ServiceSummary$LambdaEndpoint": "A summary of the configuration for the Lambda endpoint type.
" + } + }, + "ListApplicationsRequest": { + "base": null, + "refs": { + } + }, + "ListApplicationsResponse": { + "base": null, + "refs": { + } + }, + "ListEnvironmentVpcsRequest": { + "base": null, + "refs": { + } + }, + "ListEnvironmentVpcsResponse": { + "base": null, + "refs": { + } + }, + "ListEnvironmentsRequest": { + "base": null, + "refs": { + } + }, + "ListEnvironmentsResponse": { + "base": null, + "refs": { + } + }, + "ListRoutesRequest": { + "base": null, + "refs": { + } + }, + "ListRoutesResponse": { + "base": null, + "refs": { + } + }, + "ListServicesRequest": { + "base": null, + "refs": { + } + }, + "ListServicesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MaxResults": { + "base": null, + "refs": { + "ListApplicationsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The network fabric type of the environment.
", + "CreateEnvironmentResponse$NetworkFabricType": "The network fabric type of the environment.
", + "EnvironmentSummary$NetworkFabricType": "The network fabric type of the environment.
", + "GetEnvironmentResponse$NetworkFabricType": "The network fabric type of the environment.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListApplicationsRequest$NextToken": "The token for the next page of results.
", + "ListApplicationsResponse$NextToken": "The token for the next page of results.
", + "ListEnvironmentVpcsRequest$NextToken": "The token for the next page of results.
", + "ListEnvironmentVpcsResponse$NextToken": "The token for the next page of results.
", + "ListEnvironmentsRequest$NextToken": "The token for the next page of results.
", + "ListEnvironmentsResponse$NextToken": "The token for the next page of results.
", + "ListRoutesRequest$NextToken": "The token for the next page of results.
", + "ListRoutesResponse$NextToken": "The token for the next page of results.
", + "ListServicesRequest$NextToken": "The token for the next page of results.
", + "ListServicesResponse$NextToken": "The token for the next page of results.
" + } + }, + "NlbArn": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$NlbArn": "The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
", + "ApiGatewayProxySummary$NlbArn": "The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.
" + } + }, + "NlbName": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$NlbName": "The name of the Network Load Balancer that is configured by the API Gateway proxy.
", + "ApiGatewayProxySummary$NlbName": "The name of the Network Load Balancer that is configured by the API Gateway proxy.
" + } + }, + "PathResourceToId": { + "base": null, + "refs": { + "GetRouteResponse$PathResourceToId": "A mapping of Amazon API Gateway path resources to resource IDs.
", + "RouteSummary$PathResourceToId": "A mapping of Amazon API Gateway path resources to resource IDs.
" + } + }, + "PathResourceToIdKey": { + "base": null, + "refs": { + "PathResourceToId$key": null + } + }, + "PathResourceToIdValue": { + "base": null, + "refs": { + "PathResourceToId$value": null + } + }, + "PolicyString": { + "base": null, + "refs": { + "GetResourcePolicyResponse$Policy": "A JSON-formatted string for an Amazon Web Services resource-based policy.
", + "PutResourcePolicyRequest$Policy": "A JSON-formatted string for an Amazon Web Services resource-based policy.
" + } + }, + "ProxyType": { + "base": null, + "refs": { + "ApplicationSummary$ProxyType": "The proxy type of the proxy created within the application.
", + "CreateApplicationRequest$ProxyType": "The proxy type of the proxy created within the application.
", + "CreateApplicationResponse$ProxyType": "The proxy type of the proxy created within the application.
", + "GetApplicationResponse$ProxyType": "The proxy type of the proxy created within the application.
" + } + }, + "PutResourcePolicyRequest": { + "base": null, + "refs": { + } + }, + "PutResourcePolicyResponse": { + "base": null, + "refs": { + } + }, + "ResourceArn": { + "base": null, + "refs": { + "ApplicationSummary$Arn": "he Amazon Resource Name (ARN) of the application.
", + "CreateApplicationResponse$Arn": "The Amazon Resource Name (ARN) of the application. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
The Amazon Resource Name (ARN) of the environment.
", + "CreateRouteResponse$Arn": "The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
The Amazon Resource Name (ARN) of the service.
", + "DeleteApplicationResponse$Arn": "The Amazon Resource Name (ARN) of the application.
", + "DeleteEnvironmentResponse$Arn": "The Amazon Resource Name (ARN) of the environment.
", + "DeleteRouteResponse$Arn": "The Amazon Resource Name (ARN) of the route.
", + "DeleteServiceResponse$Arn": "The Amazon Resource Name (ARN) of the service.
", + "EnvironmentSummary$Arn": "The Amazon Resource Name (ARN) of the environment.
", + "GetApplicationResponse$Arn": "The Amazon Resource Name (ARN) of the application.
", + "GetEnvironmentResponse$Arn": "The Amazon Resource Name (ARN) of the environment.
", + "GetRouteResponse$Arn": "The Amazon Resource Name (ARN) of the route.
", + "GetServiceResponse$Arn": "The Amazon Resource Name (ARN) of the service.
", + "PutResourcePolicyRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource to which the policy is being attached.
", + "RouteSummary$Arn": "The Amazon Resource Name (ARN) of the route.
", + "ServiceSummary$Arn": "The Amazon Resource Name (ARN) of the service.
" + } + }, + "ResourceIdentifier": { + "base": null, + "refs": { + "ErrorResponse$ResourceIdentifier": "The ID of the resource.
" + } + }, + "ResourceNotFoundException": { + "base": "The request references a resource that does not exist.
", + "refs": { + } + }, + "ResourcePolicyIdentifier": { + "base": null, + "refs": { + "DeleteResourcePolicyRequest$Identifier": "Amazon Resource Name (ARN) of the resource associated with the policy.
", + "GetResourcePolicyRequest$Identifier": "The Amazon Resource Name (ARN) of the resource associated with the policy.
" + } + }, + "RetryAfterSeconds": { + "base": null, + "refs": { + "ThrottlingException$RetryAfterSeconds": "The number of seconds to wait before retrying.
" + } + }, + "RouteActivationState": { + "base": null, + "refs": { + "UriPathRouteInput$ActivationState": "Indicates whether traffic is forwarded to this route’s service after the route is created.
" + } + }, + "RouteId": { + "base": null, + "refs": { + "CreateRouteResponse$RouteId": "The unique identifier of the route.
", + "DeleteRouteRequest$RouteIdentifier": "The ID of the route to delete.
", + "DeleteRouteResponse$RouteId": "The ID of the route to delete.
", + "GetRouteRequest$RouteIdentifier": "The ID of the route.
", + "GetRouteResponse$RouteId": "The unique identifier of the route.
DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.
URI_PATH: A route that is based on a URI path.
", + "RouteSummary$RouteId": "The unique identifier of the route.
" + } + }, + "RouteState": { + "base": null, + "refs": { + "CreateRouteResponse$State": "he current state of the route.
", + "DeleteRouteResponse$State": "The current state of the route.
", + "GetRouteResponse$State": "The current state of the route.
", + "RouteSummary$State": "The current state of the route.
" + } + }, + "RouteSummaries": { + "base": null, + "refs": { + "ListRoutesResponse$RouteSummaryList": "The list of RouteSummary objects.
The summary information for the routes as a response to ListRoutes.
The route type of the route. DEFAULT indicates that all traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created. URI_PATH indicates a route that is based on a URI path.
The route type of the route.
", + "GetRouteResponse$RouteType": "The type of route.
", + "RouteSummary$RouteType": "The route type of the route.
" + } + }, + "ServiceEndpointType": { + "base": null, + "refs": { + "CreateServiceRequest$EndpointType": "The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.
", + "CreateServiceResponse$EndpointType": "The endpoint type of the service.
", + "GetServiceResponse$EndpointType": "The endpoint type of the service.
", + "ServiceSummary$EndpointType": "The endpoint type of the service.
" + } + }, + "ServiceId": { + "base": null, + "refs": { + "CreateRouteRequest$ServiceIdentifier": "The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.
", + "CreateRouteResponse$ServiceId": "The ID of service in which the rute iscreated. Traffic that matches this route is forwarded to this service.
", + "CreateServiceResponse$ServiceId": "The unique identifier of the service.
", + "DeleteRouteResponse$ServiceId": "The ID of the service that the route belongs to.
", + "DeleteServiceRequest$ServiceIdentifier": "The ID of the service to delete.
", + "DeleteServiceResponse$ServiceId": "The unique identifier of the service.
", + "GetRouteResponse$ServiceId": "The unique identifier of the service.
", + "GetServiceRequest$ServiceIdentifier": "The ID of the service.
", + "GetServiceResponse$ServiceId": "The unique identifier of the service.
", + "RouteSummary$ServiceId": "The unique identifier of the service.
", + "ServiceSummary$ServiceId": "The unique identifier of the service.
" + } + }, + "ServiceName": { + "base": null, + "refs": { + "CreateServiceRequest$Name": "The name of the service.
", + "CreateServiceResponse$Name": "The name of the service.
", + "DeleteServiceResponse$Name": "The name of the service.
", + "GetServiceResponse$Name": "The name of the service.
", + "ServiceSummary$Name": "The name of the service.
" + } + }, + "ServiceQuotaExceededException": { + "base": "The request would cause a service quota to be exceeded.
", + "refs": { + } + }, + "ServiceState": { + "base": null, + "refs": { + "CreateServiceResponse$State": "The current state of the service.
", + "DeleteServiceResponse$State": "The current state of the service.
", + "GetServiceResponse$State": "The current state of the service.
", + "ServiceSummary$State": "The current state of the service.
" + } + }, + "ServiceSummaries": { + "base": null, + "refs": { + "ListServicesResponse$ServiceSummaryList": " The list of ServiceSummary objects.
A summary for the service as a response to ListServices.
The name of the API Gateway stage. The name defaults to prod.
The name of the API Gateway stage. The name defaults to prod.
The name of the API Gateway stage. The name defaults to prod.
The ID of the resource.
", + "ConflictException$ResourceType": "The type of resource.
", + "InternalServerException$Message": null, + "InvalidResourcePolicyException$Message": null, + "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "ResourceNotFoundException$Message": null, + "ResourceNotFoundException$ResourceId": "The ID of the resource.
", + "ResourceNotFoundException$ResourceType": "The type of resource.
", + "ServiceQuotaExceededException$Message": null, + "ServiceQuotaExceededException$QuotaCode": "Service quota requirement to identify originating quota. Reached throttling quota exception.
", + "ServiceQuotaExceededException$ResourceId": "The ID of the resource.
", + "ServiceQuotaExceededException$ResourceType": "The type of resource.
", + "ServiceQuotaExceededException$ServiceCode": "Service quota requirement to identify originating service. Reached throttling quota exception service code.
", + "TagKeys$member": null, + "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource
", + "ThrottlingException$Message": null, + "ThrottlingException$QuotaCode": "Service quota requirement to identify originating quota. Reached throttling quota exception.
", + "ThrottlingException$ServiceCode": "Service quota requirement to identify originating service. Reached throttling quota exception service code.
", + "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "ValidationException$Message": null + } + }, + "TagKeys": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "The list of keys of the tags to be removed from the resource.
" + } + }, + "TagMap": { + "base": "A collection of up to 50 unique tags
", + "refs": { + "ApplicationSummary$Tags": "The tags assigned to the application.
", + "CreateApplicationRequest$Tags": "The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "CreateApplicationResponse$Tags": "The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "CreateEnvironmentRequest$Tags": "The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "CreateEnvironmentResponse$Tags": "The tags assigned to the created environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
", + "CreateRouteRequest$Tags": "The tags to assign to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
", + "CreateRouteResponse$Tags": "The tags assigned to the created route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "CreateServiceRequest$Tags": "The tags to assign to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
", + "CreateServiceResponse$Tags": "The tags assigned to the created service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
", + "EnvironmentSummary$Tags": "The tags assigned to the environment.
", + "GetApplicationResponse$Tags": "The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "GetEnvironmentResponse$Tags": "The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "GetRouteResponse$Tags": "The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "GetServiceResponse$Tags": "The tags assigned to the service. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
", + "ListTagsForResourceResponse$Tags": "The list of tags assigned to the resource.
", + "RouteSummary$Tags": "The tags assigned to the route.
", + "ServiceSummary$Tags": "The tags assigned to the service.
", + "TagResourceRequest$Tags": "The new or modified tags for the resource.
" + } + }, + "TagMapKeyString": { + "base": null, + "refs": { + "TagMap$key": null + } + }, + "TagMapValueString": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "ThrottlingException": { + "base": "Request was denied because the request was throttled.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "ApplicationSummary$CreatedTime": "A timestamp that indicates when the application is created.
", + "ApplicationSummary$LastUpdatedTime": "A timestamp that indicates when the application was last updated.
", + "CreateApplicationResponse$CreatedTime": "A timestamp that indicates when the application is created.
", + "CreateApplicationResponse$LastUpdatedTime": "A timestamp that indicates when the application was last updated.
", + "CreateEnvironmentResponse$CreatedTime": "A timestamp that indicates when the environment is created.
", + "CreateEnvironmentResponse$LastUpdatedTime": "A timestamp that indicates when the environment was last updated.
", + "CreateRouteResponse$CreatedTime": "A timestamp that indicates when the route is created.
", + "CreateRouteResponse$LastUpdatedTime": "A timestamp that indicates when the route was last updated.
", + "CreateServiceResponse$CreatedTime": "A timestamp that indicates when the service is created.
", + "CreateServiceResponse$LastUpdatedTime": "A timestamp that indicates when the service was last updated.
", + "DeleteApplicationResponse$LastUpdatedTime": "A timestamp that indicates when the environment was last updated.
", + "DeleteEnvironmentResponse$LastUpdatedTime": "A timestamp that indicates when the environment was last updated.
", + "DeleteRouteResponse$LastUpdatedTime": "A timestamp that indicates when the route was last updated.
", + "DeleteServiceResponse$LastUpdatedTime": "A timestamp that indicates when the service was last updated.
", + "EnvironmentSummary$CreatedTime": "A timestamp that indicates when the environment is created.
", + "EnvironmentSummary$LastUpdatedTime": "A timestamp that indicates when the environment was last updated.
", + "EnvironmentVpc$CreatedTime": "A timestamp that indicates when the VPC is first added to the environment.
", + "EnvironmentVpc$LastUpdatedTime": "A timestamp that indicates when the VPC was last updated by the environment.
", + "GetApplicationResponse$CreatedTime": "A timestamp that indicates when the application is created.
", + "GetApplicationResponse$LastUpdatedTime": "A timestamp that indicates when the application was last updated.
", + "GetEnvironmentResponse$CreatedTime": "A timestamp that indicates when the environment is created.
", + "GetEnvironmentResponse$LastUpdatedTime": "A timestamp that indicates when the environment was last updated.
", + "GetRouteResponse$CreatedTime": "The timestamp of when the route is created.
", + "GetRouteResponse$LastUpdatedTime": "A timestamp that indicates when the route was last updated.
", + "GetServiceResponse$CreatedTime": "The timestamp of when the service is created.
", + "GetServiceResponse$LastUpdatedTime": "A timestamp that indicates when the service was last updated.
", + "RouteSummary$CreatedTime": "A timestamp that indicates when the route is created.
", + "RouteSummary$LastUpdatedTime": "A timestamp that indicates when the route was last updated.
", + "ServiceSummary$CreatedTime": "A timestamp that indicates when the service is created.
", + "ServiceSummary$LastUpdatedTime": "A timestamp that indicates when the service was last updated.
" + } + }, + "TransitGatewayId": { + "base": null, + "refs": { + "EnvironmentSummary$TransitGatewayId": "The ID of the transit gateway set up by the environment.
", + "GetEnvironmentResponse$TransitGatewayId": "The ID of the transit gateway set up by the environment.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "Uri": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$ProxyUrl": "The endpoint URL of the API Gateway proxy.
", + "ApiGatewayProxySummary$ProxyUrl": "The endpoint URL of the API Gateway proxy.
", + "UrlEndpointConfig$HealthUrl": "The health check URL of the URL endpoint type.
", + "UrlEndpointConfig$Url": "The HTTP URL endpoint.
", + "UrlEndpointInput$HealthUrl": "The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.
The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.
The health check URL of the URL endpoint type. If the URL is a public endpoint, the HealthUrl must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.
The URL to route traffic to. The URL must be an rfc3986-formatted URL. If the host is a domain name, the name must be resolvable over the public internet. If the scheme is https, the top level domain of the host must be listed in the IANA root zone database.
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
The path to use to match traffic. Paths must start with / and are relative to the base of the application.
The configuration for the URI path route type.
", + "refs": { + "CreateRouteRequest$UriPathRoute": "The configuration for the URI path route type.
", + "CreateRouteResponse$UriPathRoute": "onfiguration for the URI path route type.
" + } + }, + "UrlEndpointConfig": { + "base": "The configuration for the URL endpoint type.
", + "refs": { + "GetServiceResponse$UrlEndpoint": "The configuration for the URL endpoint type.
The Url isthe URL of the endpoint type.
The HealthUrl is the health check URL of the endpoint type.
" + } + }, + "UrlEndpointInput": { + "base": "The configuration for the URL endpoint type.
", + "refs": { + "CreateServiceRequest$UrlEndpoint": "The configuration for the URL endpoint type.
", + "CreateServiceResponse$UrlEndpoint": "The configuration for the URL endpoint type.
" + } + }, + "UrlEndpointSummary": { + "base": "The summary of the configuration for the URL endpoint type.
", + "refs": { + "ServiceSummary$UrlEndpoint": "The summary of the configuration for the URL endpoint type.
" + } + }, + "ValidationException": { + "base": "The input does not satisfy the constraints specified by an Amazon Web Service.
", + "refs": { + } + }, + "VpcId": { + "base": null, + "refs": { + "ApplicationSummary$VpcId": "The ID of the virtual private cloud (VPC).
", + "CreateApplicationRequest$VpcId": "The ID of the virtual private cloud (VPC).
", + "CreateApplicationResponse$VpcId": "The ID of the Amazon VPC.
", + "CreateServiceRequest$VpcId": "The ID of the VPC.
", + "CreateServiceResponse$VpcId": "The ID of the VPC.
", + "EnvironmentVpc$VpcId": "The ID of the VPC.
", + "GetApplicationResponse$VpcId": "The ID of the virtual private cloud (VPC).
", + "GetServiceResponse$VpcId": "The ID of the virtual private cloud (VPC).
", + "ServiceSummary$VpcId": "The ID of the virtual private cloud (VPC).
" + } + }, + "VpcLinkId": { + "base": null, + "refs": { + "ApiGatewayProxyConfig$VpcLinkId": "The VpcLink ID of the API Gateway proxy.
The VpcLink ID of the API Gateway proxy.
Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.
The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.
Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
RELATED_ITEMS - itemId required, userId not used
USER_PERSONALIZATION - itemId optional, userId required
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to create the solution backing the campaign as follows:
USER_PERSONALIZATION - userId required, itemId not used
RELATED_ITEMS - itemId required, userId not used
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.
For recommenders, the recommender's ARN is required and the required item and user input depends on the use case (domain-based recipe) backing the recommender. For information on use case requirements see Choosing recommender use cases.
" }, "shapes": { "Arn": { @@ -12,7 +12,8 @@ "GetPersonalizedRankingRequest$campaignArn": "The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.
", "GetPersonalizedRankingRequest$filterArn": "The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user. For more information, see Filtering Recommendations.
", "GetRecommendationsRequest$campaignArn": "The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.
", - "GetRecommendationsRequest$filterArn": "The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.
When using this parameter, be sure the filter resource is ACTIVE.
The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.
When using this parameter, be sure the filter resource is ACTIVE.
The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.
" } }, "AttributeName": { @@ -103,7 +104,7 @@ "base": null, "refs": { "GetPersonalizedRankingResponse$personalizedRanking": "A list of items in order of most likely interest to the user. The maximum is 500.
", - "GetRecommendationsResponse$itemList": "A list of recommendations sorted in ascending order by prediction score. There can be a maximum of 500 items in the list.
" + "GetRecommendationsResponse$itemList": "A list of recommendations sorted in descending order by prediction score. There can be a maximum of 500 items in the list.
" } }, "NumResults": { diff --git a/models/apis/personalize/2018-05-22/api-2.json b/models/apis/personalize/2018-05-22/api-2.json index a7a00ada83b..2f8f6b093a1 100644 --- a/models/apis/personalize/2018-05-22/api-2.json +++ b/models/apis/personalize/2018-05-22/api-2.json @@ -29,6 +29,22 @@ {"shape":"ResourceInUseException"} ] }, + "CreateBatchSegmentJob":{ + "name":"CreateBatchSegmentJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBatchSegmentJobRequest"}, + "output":{"shape":"CreateBatchSegmentJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ] + }, "CreateCampaign":{ "name":"CreateCampaign", "http":{ @@ -142,6 +158,22 @@ {"shape":"LimitExceededException"} ] }, + "CreateRecommender":{ + "name":"CreateRecommender", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRecommenderRequest"}, + "output":{"shape":"CreateRecommenderResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "idempotent":true + }, "CreateSchema":{ "name":"CreateSchema", "http":{ @@ -257,6 +289,20 @@ {"shape":"ResourceInUseException"} ] }, + "DeleteRecommender":{ + "name":"DeleteRecommender", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRecommenderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, "DeleteSchema":{ "name":"DeleteSchema", "http":{ @@ -313,6 +359,20 @@ ], "idempotent":true }, + "DescribeBatchSegmentJob":{ + "name":"DescribeBatchSegmentJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBatchSegmentJobRequest"}, + "output":{"shape":"DescribeBatchSegmentJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "DescribeCampaign":{ "name":"DescribeCampaign", "http":{ @@ -439,6 +499,20 @@ ], "idempotent":true }, + "DescribeRecommender":{ + "name":"DescribeRecommender", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRecommenderRequest"}, + "output":{"shape":"DescribeRecommenderResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "DescribeSchema":{ "name":"DescribeSchema", "http":{ @@ -509,6 +583,20 @@ ], "idempotent":true }, + "ListBatchSegmentJobs":{ + "name":"ListBatchSegmentJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBatchSegmentJobsRequest"}, + "output":{"shape":"ListBatchSegmentJobsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "idempotent":true + }, "ListCampaigns":{ "name":"ListCampaigns", "http":{ @@ -615,6 +703,21 @@ "input":{"shape":"ListRecipesRequest"}, "output":{"shape":"ListRecipesResponse"}, "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, + "ListRecommenders":{ + "name":"ListRecommenders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecommendersRequest"}, + "output":{"shape":"ListRecommendersResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, {"shape":"InvalidNextTokenException"} ], "idempotent":true @@ -689,6 +792,21 @@ {"shape":"ResourceInUseException"} ], "idempotent":true + }, + "UpdateRecommender":{ + "name":"UpdateRecommender", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRecommenderRequest"}, + "output":{"shape":"UpdateRecommenderResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true } }, "shapes":{ @@ -801,6 +919,54 @@ "member":{"shape":"BatchInferenceJobSummary"}, "max":100 }, + "BatchSegmentJob":{ + "type":"structure", + "members":{ + "jobName":{"shape":"Name"}, + "batchSegmentJobArn":{"shape":"Arn"}, + "filterArn":{"shape":"Arn"}, + "failureReason":{"shape":"FailureReason"}, + "solutionVersionArn":{"shape":"Arn"}, + "numResults":{"shape":"NumBatchResults"}, + "jobInput":{"shape":"BatchSegmentJobInput"}, + "jobOutput":{"shape":"BatchSegmentJobOutput"}, + "roleArn":{"shape":"RoleArn"}, + "status":{"shape":"Status"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"} + } + }, + "BatchSegmentJobInput":{ + "type":"structure", + "required":["s3DataSource"], + "members":{ + "s3DataSource":{"shape":"S3DataConfig"} + } + }, + "BatchSegmentJobOutput":{ + "type":"structure", + "required":["s3DataDestination"], + "members":{ + "s3DataDestination":{"shape":"S3DataConfig"} + } + }, + "BatchSegmentJobSummary":{ + "type":"structure", + "members":{ + "batchSegmentJobArn":{"shape":"Arn"}, + "jobName":{"shape":"Name"}, + "status":{"shape":"Status"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"}, + "failureReason":{"shape":"FailureReason"}, + "solutionVersionArn":{"shape":"Arn"} + } + }, + "BatchSegmentJobs":{ + "type":"list", + "member":{"shape":"BatchSegmentJobSummary"}, + "max":100 + }, "Boolean":{"type":"boolean"}, "Campaign":{ "type":"structure", @@ -919,6 +1085,31 @@ "batchInferenceJobArn":{"shape":"Arn"} } }, + "CreateBatchSegmentJobRequest":{ + "type":"structure", + "required":[ + "jobName", + "solutionVersionArn", + "jobInput", + "jobOutput", + "roleArn" + ], + "members":{ + "jobName":{"shape":"Name"}, + "solutionVersionArn":{"shape":"Arn"}, + "filterArn":{"shape":"Arn"}, + "numResults":{"shape":"NumBatchResults"}, + "jobInput":{"shape":"BatchSegmentJobInput"}, + "jobOutput":{"shape":"BatchSegmentJobOutput"}, + "roleArn":{"shape":"RoleArn"} + } + }, + "CreateBatchSegmentJobResponse":{ + "type":"structure", + "members":{ + "batchSegmentJobArn":{"shape":"Arn"} + } + }, "CreateCampaignRequest":{ "type":"structure", "required":[ @@ -966,13 +1157,15 @@ "members":{ "name":{"shape":"Name"}, "roleArn":{"shape":"RoleArn"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "domain":{"shape":"Domain"} } }, "CreateDatasetGroupResponse":{ "type":"structure", "members":{ - "datasetGroupArn":{"shape":"Arn"} + "datasetGroupArn":{"shape":"Arn"}, + "domain":{"shape":"Domain"} } }, "CreateDatasetImportJobRequest":{ @@ -1054,6 +1247,26 @@ "filterArn":{"shape":"Arn"} } }, + "CreateRecommenderRequest":{ + "type":"structure", + "required":[ + "name", + "datasetGroupArn", + "recipeArn" + ], + "members":{ + "name":{"shape":"Name"}, + "datasetGroupArn":{"shape":"Arn"}, + "recipeArn":{"shape":"Arn"}, + "recommenderConfig":{"shape":"RecommenderConfig"} + } + }, + "CreateRecommenderResponse":{ + "type":"structure", + "members":{ + "recommenderArn":{"shape":"Arn"} + } + }, "CreateSchemaRequest":{ "type":"structure", "required":[ @@ -1062,7 +1275,8 @@ ], "members":{ "name":{"shape":"Name"}, - "schema":{"shape":"AvroSchema"} + "schema":{"shape":"AvroSchema"}, + "domain":{"shape":"Domain"} } }, "CreateSchemaResponse":{ @@ -1174,7 +1388,8 @@ "kmsKeyArn":{"shape":"KmsKeyArn"}, "creationDateTime":{"shape":"Date"}, "lastUpdatedDateTime":{"shape":"Date"}, - "failureReason":{"shape":"FailureReason"} + "failureReason":{"shape":"FailureReason"}, + "domain":{"shape":"Domain"} } }, "DatasetGroupSummary":{ @@ -1185,7 +1400,8 @@ "status":{"shape":"Status"}, "creationDateTime":{"shape":"Date"}, "lastUpdatedDateTime":{"shape":"Date"}, - "failureReason":{"shape":"FailureReason"} + "failureReason":{"shape":"FailureReason"}, + "domain":{"shape":"Domain"} } }, "DatasetGroups":{ @@ -1230,7 +1446,8 @@ "schemaArn":{"shape":"Arn"}, "schema":{"shape":"AvroSchema"}, "creationDateTime":{"shape":"Date"}, - "lastUpdatedDateTime":{"shape":"Date"} + "lastUpdatedDateTime":{"shape":"Date"}, + "domain":{"shape":"Domain"} } }, "DatasetSchemaSummary":{ @@ -1239,7 +1456,8 @@ "name":{"shape":"Name"}, "schemaArn":{"shape":"Arn"}, "creationDateTime":{"shape":"Date"}, - "lastUpdatedDateTime":{"shape":"Date"} + "lastUpdatedDateTime":{"shape":"Date"}, + "domain":{"shape":"Domain"} } }, "DatasetSummary":{ @@ -1347,6 +1565,13 @@ "filterArn":{"shape":"Arn"} } }, + "DeleteRecommenderRequest":{ + "type":"structure", + "required":["recommenderArn"], + "members":{ + "recommenderArn":{"shape":"Arn"} + } + }, "DeleteSchemaRequest":{ "type":"structure", "required":["schemaArn"], @@ -1387,6 +1612,19 @@ "batchInferenceJob":{"shape":"BatchInferenceJob"} } }, + "DescribeBatchSegmentJobRequest":{ + "type":"structure", + "required":["batchSegmentJobArn"], + "members":{ + "batchSegmentJobArn":{"shape":"Arn"} + } + }, + "DescribeBatchSegmentJobResponse":{ + "type":"structure", + "members":{ + "batchSegmentJob":{"shape":"BatchSegmentJob"} + } + }, "DescribeCampaignRequest":{ "type":"structure", "required":["campaignArn"], @@ -1504,6 +1742,19 @@ "recipe":{"shape":"Recipe"} } }, + "DescribeRecommenderRequest":{ + "type":"structure", + "required":["recommenderArn"], + "members":{ + "recommenderArn":{"shape":"Arn"} + } + }, + "DescribeRecommenderResponse":{ + "type":"structure", + "members":{ + "recommender":{"shape":"Recommender"} + } + }, "DescribeSchemaRequest":{ "type":"structure", "required":["schemaArn"], @@ -1548,6 +1799,13 @@ "type":"string", "max":256 }, + "Domain":{ + "type":"string", + "enum":[ + "ECOMMERCE", + "VIDEO_ON_DEMAND" + ] + }, "ErrorMessage":{"type":"string"}, "EventTracker":{ "type":"structure", @@ -1754,6 +2012,7 @@ }, "KmsKeyArn":{ "type":"string", + "max":2048, "pattern":"arn:aws.*:kms:.*:[0-9]{12}:key/.*" }, "LimitExceededException":{ @@ -1778,6 +2037,21 @@ "nextToken":{"shape":"NextToken"} } }, + "ListBatchSegmentJobsRequest":{ + "type":"structure", + "members":{ + "solutionVersionArn":{"shape":"Arn"}, + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListBatchSegmentJobsResponse":{ + "type":"structure", + "members":{ + "batchSegmentJobs":{"shape":"BatchSegmentJobs"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListCampaignsRequest":{ "type":"structure", "members":{ @@ -1887,7 +2161,8 @@ "members":{ "recipeProvider":{"shape":"RecipeProvider"}, "nextToken":{"shape":"NextToken"}, - "maxResults":{"shape":"MaxResults"} + "maxResults":{"shape":"MaxResults"}, + "domain":{"shape":"Domain"} } }, "ListRecipesResponse":{ @@ -1897,6 +2172,21 @@ "nextToken":{"shape":"NextToken"} } }, + "ListRecommendersRequest":{ + "type":"structure", + "members":{ + "datasetGroupArn":{"shape":"Arn"}, + "nextToken":{"shape":"NextToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListRecommendersResponse":{ + "type":"structure", + "members":{ + "recommenders":{"shape":"Recommenders"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListSchemasRequest":{ "type":"structure", "members":{ @@ -1969,7 +2259,7 @@ }, "NextToken":{ "type":"string", - "max":1300 + "max":1500 }, "NumBatchResults":{"type":"integer"}, "ObjectiveSensitivity":{ @@ -2023,7 +2313,8 @@ "recipeArn":{"shape":"Arn"}, "status":{"shape":"Status"}, "creationDateTime":{"shape":"Date"}, - "lastUpdatedDateTime":{"shape":"Date"} + "lastUpdatedDateTime":{"shape":"Date"}, + "domain":{"shape":"Domain"} } }, "RecipeType":{ @@ -2035,6 +2326,55 @@ "member":{"shape":"RecipeSummary"}, "max":100 }, + "Recommender":{ + "type":"structure", + "members":{ + "recommenderArn":{"shape":"Arn"}, + "datasetGroupArn":{"shape":"Arn"}, + "name":{"shape":"Name"}, + "recipeArn":{"shape":"Arn"}, + "recommenderConfig":{"shape":"RecommenderConfig"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"}, + "status":{"shape":"Status"}, + "failureReason":{"shape":"FailureReason"}, + "latestRecommenderUpdate":{"shape":"RecommenderUpdateSummary"} + } + }, + "RecommenderConfig":{ + "type":"structure", + "members":{ + "itemExplorationConfig":{"shape":"HyperParameters"} + } + }, + "RecommenderSummary":{ + "type":"structure", + "members":{ + "name":{"shape":"Name"}, + "recommenderArn":{"shape":"Arn"}, + "datasetGroupArn":{"shape":"Arn"}, + "recipeArn":{"shape":"Arn"}, + "recommenderConfig":{"shape":"RecommenderConfig"}, + "status":{"shape":"Status"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"} + } + }, + "RecommenderUpdateSummary":{ + "type":"structure", + "members":{ + "recommenderConfig":{"shape":"RecommenderConfig"}, + "creationDateTime":{"shape":"Date"}, + "lastUpdatedDateTime":{"shape":"Date"}, + "status":{"shape":"Status"}, + "failureReason":{"shape":"FailureReason"} + } + }, + "Recommenders":{ + "type":"list", + "member":{"shape":"RecommenderSummary"}, + "max":100 + }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ @@ -2220,6 +2560,23 @@ "members":{ "campaignArn":{"shape":"Arn"} } + }, + "UpdateRecommenderRequest":{ + "type":"structure", + "required":[ + "recommenderArn", + "recommenderConfig" + ], + "members":{ + "recommenderArn":{"shape":"Arn"}, + "recommenderConfig":{"shape":"RecommenderConfig"} + } + }, + "UpdateRecommenderResponse":{ + "type":"structure", + "members":{ + "recommenderArn":{"shape":"Arn"} + } } } } diff --git a/models/apis/personalize/2018-05-22/docs-2.json b/models/apis/personalize/2018-05-22/docs-2.json index cfccb2d5f75..8bff0166158 100644 --- a/models/apis/personalize/2018-05-22/docs-2.json +++ b/models/apis/personalize/2018-05-22/docs-2.json @@ -3,25 +3,29 @@ "service": "Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.
", "operations": { "CreateBatchInferenceJob": "Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
", - "CreateCampaign": "Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.
Related APIs
", + "CreateBatchSegmentJob": "Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
", + "CreateCampaign": "Creates a campaign that deploys a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.
Minimum Provisioned TPS and Auto-Scaling
A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.
If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.
The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.
Status
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the campaign status, call DescribeCampaign.
Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.
Related APIs
", "CreateDataset": "Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.
There are three types of datasets:
Interactions
Items
Users
Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).
A dataset can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the dataset, call DescribeDataset.
Related APIs
", "CreateDatasetExportJob": " Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide.
Status
A dataset export job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
", + "CreateDatasetGroup": "Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.
You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
Related APIs
", "CreateDatasetImportJob": "Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources.
The dataset import job replaces any existing data in the dataset that you imported in bulk.
Status
A dataset import job can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.
Related APIs
", "CreateEventTracker": "Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.
Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.
When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.
The event tracker can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the event tracker, call DescribeEventTracker.
The event tracker must be in the ACTIVE state before using the tracking ID.
Related APIs
", "CreateFilter": "Creates a recommendation filter. For more information, see filter.
", - "CreateSchema": "Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.
Related APIs
", + "CreateRecommender": "Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.
Related APIs
", + "CreateSchema": "Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
", "CreateSolution": "Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.
After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.
To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.
Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.
Status
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.
Related APIs
", - "CreateSolutionVersion": "Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING
CREATE IN_PROGRESS
ACTIVE
CREATE FAILED
CREATE STOPPING
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Related APIs
", + "CreateSolutionVersion": "Trains or retrains an active solution in a Custom dataset group. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.
Status
A solution version can be in one of the following states:
CREATE PENDING
CREATE IN_PROGRESS
ACTIVE
CREATE FAILED
CREATE STOPPING
CREATE STOPPED
To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.
If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
Related APIs
", "DeleteCampaign": "Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.
", "DeleteDataset": "Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.
Deletes a dataset group. Before you delete a dataset group, you must delete the following:
All associated event trackers.
All associated solutions.
All datasets in the dataset group.
Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.
", "DeleteFilter": "Deletes a filter.
", + "DeleteRecommender": "Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
", "DeleteSchema": "Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.
", "DeleteSolution": "Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.
Describes the given algorithm.
", "DescribeBatchInferenceJob": "Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.
", + "DescribeBatchSegmentJob": "Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
", "DescribeCampaign": "Describes the given campaign, including its status.
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
For more information on campaigns, see CreateCampaign.
", "DescribeDataset": "Describes the given dataset. For more information on datasets, see CreateDataset.
", "DescribeDatasetExportJob": "Describes the dataset export job created by CreateDatasetExportJob, including the export job status.
", @@ -31,11 +35,13 @@ "DescribeFeatureTransformation": "Describes the given feature transformation.
", "DescribeFilter": "Describes a filter's properties.
", "DescribeRecipe": "Describes a recipe.
A recipe contains three items:
An algorithm that trains a model.
Hyperparameters that govern the training.
Feature transformation information for modifying the input data before training.
Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.
Describes the given recommender, including its status.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED, the response includes the failureReason key, which describes why.
For more information on recommenders, see CreateRecommender.
", "DescribeSchema": "Describes a schema. For more information on schemas, see CreateSchema.
", "DescribeSolution": "Describes a solution. For more information on solutions, see CreateSolution.
", "DescribeSolutionVersion": "Describes a specific version of a solution. For more information on solutions, see CreateSolution.
", "GetSolutionMetrics": "Gets the metrics for the specified solution version.
", "ListBatchInferenceJobs": "Gets a list of the batch inference jobs that have been performed off of a solution version.
", + "ListBatchSegmentJobs": "Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
", "ListCampaigns": "Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
", "ListDatasetExportJobs": "Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.
", "ListDatasetGroups": "Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
", @@ -44,11 +50,13 @@ "ListEventTrackers": "Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.
", "ListFilters": "Lists all filters that belong to a given dataset group.
", "ListRecipes": "Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
", + "ListRecommenders": "Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
", "ListSchemas": "Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
", "ListSolutionVersions": "Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
", "ListSolutions": "Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.
", "StopSolutionVersionCreation": "Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.
Depending on the current state of the solution version, the solution version state changes as follows:
CREATE_PENDING > CREATE_STOPPED
or
CREATE_IN_PROGRESS > CREATE_STOPPING > CREATE_STOPPED
You are billed for all of the training completed up until you stop the solution version creation. You cannot resume creating a solution version once it has been stopped.
", - "UpdateCampaign": "Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.
You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.
For more information on campaigns, see CreateCampaign.
" + "UpdateCampaign": "Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.
To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.
You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.
For more information on campaigns, see CreateCampaign.
", + "UpdateRecommender": "Updates the recommender to modify the recommender configuration.
" }, "shapes": { "AccountId": { @@ -81,6 +89,11 @@ "BatchInferenceJob$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
", "BatchInferenceJobSummary$batchInferenceJobArn": "The Amazon Resource Name (ARN) of the batch inference job.
", "BatchInferenceJobSummary$solutionVersionArn": "The ARN of the solution version used by the batch inference job.
", + "BatchSegmentJob$batchSegmentJobArn": "The Amazon Resource Name (ARN) of the batch segment job.
", + "BatchSegmentJob$filterArn": "The ARN of the filter used on the batch segment job.
", + "BatchSegmentJob$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
", + "BatchSegmentJobSummary$batchSegmentJobArn": "The Amazon Resource Name (ARN) of the batch segment job.
", + "BatchSegmentJobSummary$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
", "Campaign$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", "Campaign$solutionVersionArn": "The Amazon Resource Name (ARN) of a specific version of the solution.
", "CampaignSummary$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", @@ -88,6 +101,9 @@ "CreateBatchInferenceJobRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.
", "CreateBatchInferenceJobRequest$filterArn": "The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering Batch Recommendations..
", "CreateBatchInferenceJobResponse$batchInferenceJobArn": "The ARN of the batch inference job.
", + "CreateBatchSegmentJobRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
", + "CreateBatchSegmentJobRequest$filterArn": "The ARN of the filter to apply to the batch segment job. For more information on using filters, see filter-batch.
", + "CreateBatchSegmentJobResponse$batchSegmentJobArn": "The ARN of the batch segment job.
", "CreateCampaignRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version to deploy.
", "CreateCampaignResponse$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", "CreateDatasetExportJobRequest$datasetArn": "The Amazon Resource Name (ARN) of the dataset that contains the data to export.
", @@ -102,6 +118,9 @@ "CreateEventTrackerResponse$eventTrackerArn": "The ARN of the event tracker.
", "CreateFilterRequest$datasetGroupArn": "The ARN of the dataset group that the filter will belong to.
", "CreateFilterResponse$filterArn": "The ARN of the new filter.
", + "CreateRecommenderRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
", + "CreateRecommenderRequest$recipeArn": "The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
", + "CreateRecommenderResponse$recommenderArn": "The Amazon Resource Name (ARN) of the recommender.
", "CreateSchemaResponse$schemaArn": "The Amazon Resource Name (ARN) of the created schema.
", "CreateSolutionRequest$recipeArn": "The ARN of the recipe to use for model training. Only specified when performAutoML is false.
The Amazon Resource Name (ARN) of the dataset group that provides the training data.
", @@ -129,10 +148,12 @@ "DeleteDatasetRequest$datasetArn": "The Amazon Resource Name (ARN) of the dataset to delete.
", "DeleteEventTrackerRequest$eventTrackerArn": "The Amazon Resource Name (ARN) of the event tracker to delete.
", "DeleteFilterRequest$filterArn": "The ARN of the filter to delete.
", + "DeleteRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to delete.
", "DeleteSchemaRequest$schemaArn": "The Amazon Resource Name (ARN) of the schema to delete.
", "DeleteSolutionRequest$solutionArn": "The ARN of the solution to delete.
", "DescribeAlgorithmRequest$algorithmArn": "The Amazon Resource Name (ARN) of the algorithm to describe.
", "DescribeBatchInferenceJobRequest$batchInferenceJobArn": "The ARN of the batch inference job to describe.
", + "DescribeBatchSegmentJobRequest$batchSegmentJobArn": "The ARN of the batch segment job to describe.
", "DescribeCampaignRequest$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", "DescribeDatasetExportJobRequest$datasetExportJobArn": "The Amazon Resource Name (ARN) of the dataset export job to describe.
", "DescribeDatasetGroupRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group to describe.
", @@ -142,6 +163,7 @@ "DescribeFeatureTransformationRequest$featureTransformationArn": "The Amazon Resource Name (ARN) of the feature transformation to describe.
", "DescribeFilterRequest$filterArn": "The ARN of the filter to describe.
", "DescribeRecipeRequest$recipeArn": "The Amazon Resource Name (ARN) of the recipe to describe.
", + "DescribeRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to describe.
", "DescribeSchemaRequest$schemaArn": "The Amazon Resource Name (ARN) of the schema to retrieve.
", "DescribeSolutionRequest$solutionArn": "The Amazon Resource Name (ARN) of the solution to describe.
", "DescribeSolutionVersionRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version.
", @@ -156,18 +178,26 @@ "GetSolutionMetricsRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version for which to get metrics.
", "GetSolutionMetricsResponse$solutionVersionArn": "The same solution version ARN as specified in the request.
", "ListBatchInferenceJobsRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.
", + "ListBatchSegmentJobsRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
", "ListCampaignsRequest$solutionArn": "The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
", "ListDatasetExportJobsRequest$datasetArn": "The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.
", "ListDatasetImportJobsRequest$datasetArn": "The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.
", "ListDatasetsRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
", "ListEventTrackersRequest$datasetGroupArn": "The ARN of a dataset group used to filter the response.
", "ListFiltersRequest$datasetGroupArn": "The ARN of the dataset group that contains the filters.
", + "ListRecommendersRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
", "ListSolutionVersionsRequest$solutionArn": "The Amazon Resource Name (ARN) of the solution.
", "ListSolutionsRequest$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group.
", "Recipe$recipeArn": "The Amazon Resource Name (ARN) of the recipe.
", "Recipe$algorithmArn": "The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.
", "Recipe$featureTransformationArn": "The ARN of the FeatureTransformation object.
", "RecipeSummary$recipeArn": "The Amazon Resource Name (ARN) of the recipe.
", + "Recommender$recommenderArn": "The Amazon Resource Name (ARN) of the recommender.
", + "Recommender$datasetGroupArn": "The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
", + "Recommender$recipeArn": "The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
", + "RecommenderSummary$recommenderArn": "The Amazon Resource Name (ARN) of the recommender.
", + "RecommenderSummary$datasetGroupArn": "The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
", + "RecommenderSummary$recipeArn": "The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
", "Solution$solutionArn": "The ARN of the solution.
", "Solution$recipeArn": "The ARN of the recipe used to create the solution.
", "Solution$datasetGroupArn": "The Amazon Resource Name (ARN) of the dataset group that provides the training data.
", @@ -180,7 +210,9 @@ "StopSolutionVersionCreationRequest$solutionVersionArn": "The Amazon Resource Name (ARN) of the solution version you want to stop creating.
", "UpdateCampaignRequest$campaignArn": "The Amazon Resource Name (ARN) of the campaign.
", "UpdateCampaignRequest$solutionVersionArn": "The ARN of a new solution version to deploy.
", - "UpdateCampaignResponse$campaignArn": "The same campaign ARN as given in the request.
" + "UpdateCampaignResponse$campaignArn": "The same campaign ARN as given in the request.
", + "UpdateRecommenderRequest$recommenderArn": "The Amazon Resource Name (ARN) of the recommender to modify.
", + "UpdateRecommenderResponse$recommenderArn": "The same recommender Amazon Resource Name (ARN) as given in the request.
" } }, "ArnList": { @@ -247,6 +279,38 @@ "ListBatchInferenceJobsResponse$batchInferenceJobs": "A list containing information on each job that is returned.
" } }, + "BatchSegmentJob": { + "base": "Contains information on a batch segment job.
", + "refs": { + "DescribeBatchSegmentJobResponse$batchSegmentJob": "Information on the specified batch segment job.
" + } + }, + "BatchSegmentJobInput": { + "base": "The input configuration of a batch segment job.
", + "refs": { + "BatchSegmentJob$jobInput": "The Amazon S3 path that leads to the input data used to generate the batch segment job.
", + "CreateBatchSegmentJobRequest$jobInput": "The Amazon S3 path for the input data used to generate the batch segment job.
" + } + }, + "BatchSegmentJobOutput": { + "base": "The output configuration parameters of a batch segment job.
", + "refs": { + "BatchSegmentJob$jobOutput": "The Amazon S3 bucket that contains the output data generated by the batch segment job.
", + "CreateBatchSegmentJobRequest$jobOutput": "The Amazon S3 path for the bucket where the job's output will be stored.
" + } + }, + "BatchSegmentJobSummary": { + "base": "A truncated version of the BatchSegmentJob datatype. The ListBatchSegmentJobs operation returns a list of batch segment job summaries.
", + "refs": { + "BatchSegmentJobs$member": null + } + }, + "BatchSegmentJobs": { + "base": null, + "refs": { + "ListBatchSegmentJobsResponse$batchSegmentJobs": "A list containing information on each job that is returned.
" + } + }, "Boolean": { "base": null, "refs": { @@ -254,7 +318,7 @@ } }, "Campaign": { - "base": "Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.
", + "base": "An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.
", "refs": { "DescribeCampaignResponse$campaign": "The properties of the campaign.
" } @@ -347,6 +411,16 @@ "refs": { } }, + "CreateBatchSegmentJobRequest": { + "base": null, + "refs": { + } + }, + "CreateBatchSegmentJobResponse": { + "base": null, + "refs": { + } + }, "CreateCampaignRequest": { "base": null, "refs": { @@ -417,6 +491,16 @@ "refs": { } }, + "CreateRecommenderRequest": { + "base": null, + "refs": { + } + }, + "CreateRecommenderResponse": { + "base": null, + "refs": { + } + }, "CreateSchemaRequest": { "base": null, "refs": { @@ -562,6 +646,10 @@ "BatchInferenceJob$lastUpdatedDateTime": "The time at which the batch inference job was last updated.
", "BatchInferenceJobSummary$creationDateTime": "The time at which the batch inference job was created.
", "BatchInferenceJobSummary$lastUpdatedDateTime": "The time at which the batch inference job was last updated.
", + "BatchSegmentJob$creationDateTime": "The time at which the batch segment job was created.
", + "BatchSegmentJob$lastUpdatedDateTime": "The time at which the batch segment job last updated.
", + "BatchSegmentJobSummary$creationDateTime": "The time at which the batch segment job was created.
", + "BatchSegmentJobSummary$lastUpdatedDateTime": "The time at which the batch segment job was last updated.
", "Campaign$creationDateTime": "The date and time (in Unix format) that the campaign was created.
", "Campaign$lastUpdatedDateTime": "The date and time (in Unix format) that the campaign was last updated.
", "CampaignSummary$creationDateTime": "The date and time (in Unix time) that the campaign was created.
", @@ -602,6 +690,12 @@ "Recipe$lastUpdatedDateTime": "The date and time (in Unix format) that the recipe was last updated.
", "RecipeSummary$creationDateTime": "The date and time (in Unix time) that the recipe was created.
", "RecipeSummary$lastUpdatedDateTime": "The date and time (in Unix time) that the recipe was last updated.
", + "Recommender$creationDateTime": "The date and time (in Unix format) that the recommender was created.
", + "Recommender$lastUpdatedDateTime": "The date and time (in Unix format) that the recommender was last updated.
", + "RecommenderSummary$creationDateTime": "The date and time (in Unix format) that the recommender was created.
", + "RecommenderSummary$lastUpdatedDateTime": "The date and time (in Unix format) that the recommender was last updated.
", + "RecommenderUpdateSummary$creationDateTime": "The date and time (in Unix format) that the recommender update was created.
", + "RecommenderUpdateSummary$lastUpdatedDateTime": "The date and time (in Unix time) that the recommender update was last updated.
", "Solution$creationDateTime": "The creation date and time (in Unix time) of the solution.
", "Solution$lastUpdatedDateTime": "The date and time (in Unix time) that the solution was last updated.
", "SolutionSummary$creationDateTime": "The date and time (in Unix time) that the solution was created.
", @@ -679,6 +773,11 @@ "refs": { } }, + "DeleteRecommenderRequest": { + "base": null, + "refs": { + } + }, "DeleteSchemaRequest": { "base": null, "refs": { @@ -709,6 +808,16 @@ "refs": { } }, + "DescribeBatchSegmentJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeBatchSegmentJobResponse": { + "base": null, + "refs": { + } + }, "DescribeCampaignRequest": { "base": null, "refs": { @@ -799,6 +908,16 @@ "refs": { } }, + "DescribeRecommenderRequest": { + "base": null, + "refs": { + } + }, + "DescribeRecommenderResponse": { + "base": null, + "refs": { + } + }, "DescribeSchemaRequest": { "base": null, "refs": { @@ -841,6 +960,20 @@ "AlgorithmImage$dockerURI": "The URI of the Docker container for the algorithm image.
" } }, + "Domain": { + "base": null, + "refs": { + "CreateDatasetGroupRequest$domain": "The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
", + "CreateDatasetGroupResponse$domain": "The domain for the new Domain dataset group.
", + "CreateSchemaRequest$domain": "The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
", + "DatasetGroup$domain": "The domain of a Domain dataset group.
", + "DatasetGroupSummary$domain": "The domain of a Domain dataset group.
", + "DatasetSchema$domain": "The domain of a schema that you created for a dataset in a Domain dataset group.
", + "DatasetSchemaSummary$domain": "The domain of a schema that you created for a dataset in a Domain dataset group.
", + "ListRecipesRequest$domain": "Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, only non-domain recipes are returned.
", + "RecipeSummary$domain": "The domain of the recipe (if the recipe is a Domain dataset group use case).
" + } + }, "ErrorMessage": { "base": null, "refs": { @@ -889,6 +1022,8 @@ "refs": { "BatchInferenceJob$failureReason": "If the batch inference job failed, the reason for the failure.
", "BatchInferenceJobSummary$failureReason": "If the batch inference job failed, the reason for the failure.
", + "BatchSegmentJob$failureReason": "If the batch segment job failed, the reason for the failure.
", + "BatchSegmentJobSummary$failureReason": "If the batch segment job failed, the reason for the failure.
", "Campaign$failureReason": "If a campaign fails, the reason behind the failure.
", "CampaignSummary$failureReason": "If a campaign fails, the reason behind the failure.
", "CampaignUpdateSummary$failureReason": "If a campaign update fails, the reason behind the failure.
", @@ -900,6 +1035,8 @@ "DatasetImportJobSummary$failureReason": "If a dataset import job fails, the reason behind the failure.
", "Filter$failureReason": "If the filter failed, the reason for its failure.
", "FilterSummary$failureReason": "If the filter failed, the reason for the failure.
", + "Recommender$failureReason": "If a recommender fails, the reason behind the failure.
", + "RecommenderUpdateSummary$failureReason": "If a recommender update fails, the reason behind the failure.
", "SolutionVersion$failureReason": "If training a solution version fails, the reason for the failure.
", "SolutionVersionSummary$failureReason": "If a solution version fails, the reason behind the failure.
" } @@ -999,7 +1136,8 @@ "refs": { "Algorithm$defaultHyperParameters": "Specifies the default hyperparameters.
", "BatchInferenceJobConfig$itemExplorationConfig": "A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See User-Personalization.
A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
Lists the hyperparameter names and ranges.
", "TunedHPOParams$algorithmHyperParameters": "A list of the hyperparameter values of the best performing model.
" } @@ -1076,6 +1214,16 @@ "refs": { } }, + "ListBatchSegmentJobsRequest": { + "base": null, + "refs": { + } + }, + "ListBatchSegmentJobsResponse": { + "base": null, + "refs": { + } + }, "ListCampaignsRequest": { "base": null, "refs": { @@ -1156,6 +1304,16 @@ "refs": { } }, + "ListRecommendersRequest": { + "base": null, + "refs": { + } + }, + "ListRecommendersResponse": { + "base": null, + "refs": { + } + }, "ListSchemasRequest": { "base": null, "refs": { @@ -1190,6 +1348,7 @@ "base": null, "refs": { "ListBatchInferenceJobsRequest$maxResults": "The maximum number of batch inference job results to return in each page. The default value is 100.
", + "ListBatchSegmentJobsRequest$maxResults": "The maximum number of batch segment job results to return in each page. The default value is 100.
", "ListCampaignsRequest$maxResults": "The maximum number of campaigns to return.
", "ListDatasetExportJobsRequest$maxResults": "The maximum number of dataset export jobs to return.
", "ListDatasetGroupsRequest$maxResults": "The maximum number of dataset groups to return.
", @@ -1198,6 +1357,7 @@ "ListEventTrackersRequest$maxResults": "The maximum number of event trackers to return.
", "ListFiltersRequest$maxResults": "The maximum number of filters to return.
", "ListRecipesRequest$maxResults": "The maximum number of recipes to return.
", + "ListRecommendersRequest$maxResults": "The maximum number of recommenders to return.
", "ListSchemasRequest$maxResults": "The maximum number of schemas to return.
", "ListSolutionVersionsRequest$maxResults": "The maximum number of solution versions to return.
", "ListSolutionsRequest$maxResults": "The maximum number of solutions to return.
" @@ -1236,9 +1396,12 @@ "AlgorithmImage$name": "The name of the algorithm image.
", "BatchInferenceJob$jobName": "The name of the batch inference job.
", "BatchInferenceJobSummary$jobName": "The name of the batch inference job.
", + "BatchSegmentJob$jobName": "The name of the batch segment job.
", + "BatchSegmentJobSummary$jobName": "The name of the batch segment job.
", "Campaign$name": "The name of the campaign.
", "CampaignSummary$name": "The name of the campaign.
", "CreateBatchInferenceJobRequest$jobName": "The name of the batch inference job to create.
", + "CreateBatchSegmentJobRequest$jobName": "The name of the batch segment job to create.
", "CreateCampaignRequest$name": "A name for the new campaign. The campaign name must be unique within your account.
", "CreateDatasetExportJobRequest$jobName": "The name for the dataset export job.
", "CreateDatasetGroupRequest$name": "The name for the new dataset group.
", @@ -1246,6 +1409,7 @@ "CreateDatasetRequest$name": "The name for the dataset.
", "CreateEventTrackerRequest$name": "The name for the event tracker.
", "CreateFilterRequest$name": "The name of the filter to create.
", + "CreateRecommenderRequest$name": "The name of the recommender.
", "CreateSchemaRequest$name": "The name for the schema.
", "CreateSolutionRequest$name": "The name for the solution.
", "Dataset$name": "The name of the dataset.
", @@ -1265,6 +1429,8 @@ "FilterSummary$name": "The name of the filter.
", "Recipe$name": "The name of the recipe.
", "RecipeSummary$name": "The name of the recipe.
", + "Recommender$name": "The name of the recommender.
", + "RecommenderSummary$name": "The name of the recommender.
", "Solution$name": "The name of the solution.
", "SolutionSummary$name": "The name of the solution.
" } @@ -1274,6 +1440,8 @@ "refs": { "ListBatchInferenceJobsRequest$nextToken": "The token to request the next page of results.
", "ListBatchInferenceJobsResponse$nextToken": "The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The token to request the next page of results.
", + "ListBatchSegmentJobsResponse$nextToken": "The token to use to retrieve the next page of results. The value is null when there are no more results to return.
A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
A token for getting the next set of campaigns (if they exist).
", "ListDatasetExportJobsRequest$nextToken": "A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).
A token for getting the next set of filters (if they exist).
", "ListRecipesRequest$nextToken": "A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
A token for getting the next set of recipes.
", + "ListRecommendersRequest$nextToken": "A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).
A token for getting the next set of recommenders (if they exist).
", "ListSchemasRequest$nextToken": "A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
A token used to get the next set of schemas (if they exist).
", "ListSolutionVersionsRequest$nextToken": "A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).
The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.
", - "CreateBatchInferenceJobRequest$numResults": "The number of recommendations to retreive.
" + "BatchSegmentJob$numResults": "The number of predicted users generated by the batch segment job for each line of input data.
", + "CreateBatchInferenceJobRequest$numResults": "The number of recommendations to retreive.
", + "CreateBatchSegmentJobRequest$numResults": "The number of predicted users generated by the batch segment job for each line of input data.
" } }, "ObjectiveSensitivity": { @@ -1386,6 +1558,40 @@ "ListRecipesResponse$recipes": "The list of available recipes.
" } }, + "Recommender": { + "base": "Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group for a specific domain use case (domain recipe), and specify the recommender in a GetRecommendations request.
", + "refs": { + "DescribeRecommenderResponse$recommender": "The properties of the recommender.
" + } + }, + "RecommenderConfig": { + "base": "The configuration details of the recommender.
", + "refs": { + "CreateRecommenderRequest$recommenderConfig": "The configuration details of the recommender.
", + "Recommender$recommenderConfig": "The configuration details of the recommender.
", + "RecommenderSummary$recommenderConfig": "The configuration details of the recommender.
", + "RecommenderUpdateSummary$recommenderConfig": "The configuration details of the recommender update.
", + "UpdateRecommenderRequest$recommenderConfig": "The configuration details of the recommender.
" + } + }, + "RecommenderSummary": { + "base": "Provides a summary of the properties of the recommender.
", + "refs": { + "Recommenders$member": null + } + }, + "RecommenderUpdateSummary": { + "base": "Provides a summary of the properties of a recommender update. For a complete listing, call the DescribeRecommender API.
", + "refs": { + "Recommender$latestRecommenderUpdate": "Provides a summary of the latest updates to the recommender.
" + } + }, + "Recommenders": { + "base": null, + "refs": { + "ListRecommendersResponse$recommenders": "A list of the recommenders.
" + } + }, "ResourceAlreadyExistsException": { "base": "The specified resource already exists.
", "refs": { @@ -1411,7 +1617,9 @@ "base": null, "refs": { "BatchInferenceJob$roleArn": "The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
", + "BatchSegmentJob$roleArn": "The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
", "CreateBatchInferenceJobRequest$roleArn": "The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
", + "CreateBatchSegmentJobRequest$roleArn": "The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
", "CreateDatasetExportJobRequest$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
", "CreateDatasetGroupRequest$roleArn": "The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
", "CreateDatasetImportJobRequest$roleArn": "The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
", @@ -1423,6 +1631,8 @@ "refs": { "BatchInferenceJobInput$s3DataSource": "The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.
", "BatchInferenceJobOutput$s3DataDestination": "Information on the Amazon S3 bucket in which the batch inference job's output is stored.
", + "BatchSegmentJobInput$s3DataSource": null, + "BatchSegmentJobOutput$s3DataDestination": null, "DatasetExportJobOutput$s3DataDestination": null } }, @@ -1460,7 +1670,7 @@ } }, "SolutionVersion": { - "base": "An object that provides information about a specific version of a Solution.
", + "base": "An object that provides information about a specific version of a Solution in a Custom dataset group.
", "refs": { "DescribeSolutionVersionResponse$solutionVersion": "The solution version.
" } @@ -1489,6 +1699,8 @@ "refs": { "BatchInferenceJob$status": "The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
The status of the batch inference job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
The status of the campaign.
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the campaign.
A campaign can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the campaign update.
A campaign update can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the filter.
", "Recipe$status": "The status of the recipe.
", "RecipeSummary$status": "The status of the recipe.
", + "Recommender$status": "The status of the recommender.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the recommender. A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the recommender update.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the solution.
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the solution.
A solution can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
The status of the solution version.
A solution version can be in one of the following states:
CREATE PENDING
CREATE IN_PROGRESS
ACTIVE
CREATE FAILED
CREATE STOPPING
CREATE STOPPED
Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.
", "operations": { "AnalyzeDocument": "Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes list.
The output is returned in a list of Block objects.
AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
", - "AnalyzeExpense": "Analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows.
LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.
SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
AnalyzeExpense synchronously analyzes an input document for financially related relationships between text.
Information is returned as ExpenseDocuments and seperated as follows.
LineItemGroups- A data set containing LineItems which store information about the lines of text, such as an item purchased and its price on a receipt.
SummaryFields- Contains all other information a receipt, such as header information or the vendors name.
Analyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields, which records both the normalized field and value of the extracted text.
Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPEG or PNG format. DetectDocumentText returns the detected text in an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
", "GetDocumentAnalysis": "Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.
GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Lines and words of text. A LINE Block object contains one or more WORD Block objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis FeatureTypes input parameter).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block object contains information about a selection element, including the selection status.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.
For more information, see Document Text Analysis.
", "GetDocumentTextDetection": "Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.
GetDocumentTextDetection returns an array of Block objects.
Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.
For more information, see Document Text Detection.
", @@ -38,6 +39,23 @@ "refs": { } }, + "AnalyzeIDDetections": { + "base": "Used to contain the information detected by an AnalyzeID operation.
", + "refs": { + "IdentityDocumentField$Type": null, + "IdentityDocumentField$ValueDetection": null + } + }, + "AnalyzeIDRequest": { + "base": null, + "refs": { + } + }, + "AnalyzeIDResponse": { + "base": null, + "refs": { + } + }, "BadDocumentException": { "base": "Amazon Textract isn't able to read the document. For more information on the document limits in Amazon Textract, see limits.
", "refs": { @@ -105,7 +123,8 @@ "refs": { "AnalyzeDocumentRequest$Document": "The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes field.
Metadata about the analyzed document. An example is the number of pages.
", "AnalyzeExpenseResponse$DocumentMetadata": null, + "AnalyzeIDResponse$DocumentMetadata": null, "DetectDocumentTextResponse$DocumentMetadata": "Metadata about the document. It contains the number of pages that are detected in the document.
", "GetDocumentAnalysisResponse$DocumentMetadata": "Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.
Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract operation.
The document being passed to AnalyzeID.
" + } + }, "DocumentTooLargeException": { "base": "The document can't be processed because it's too large. The maximum document size for synchronous operations 10 MB. The maximum document size for asynchronous operations is 500 MB for PDF files.
", "refs": { @@ -171,7 +197,7 @@ } }, "ExpenseField": { - "base": "Breakdown of detected information, seperated into the catagories Type, LableDetection, and ValueDetection
", + "base": "Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
", "refs": { "ExpenseFieldList$member": null } @@ -320,6 +346,30 @@ "refs": { } }, + "IdentityDocument": { + "base": "The structure that lists each document processed in an AnalyzeID operation.
", + "refs": { + "IdentityDocumentList$member": null + } + }, + "IdentityDocumentField": { + "base": "Structure containing both the normalized type of the extracted information and the text associated with it. These are extracted as Type and Value respectively.
", + "refs": { + "IdentityDocumentFieldList$member": null + } + }, + "IdentityDocumentFieldList": { + "base": null, + "refs": { + "IdentityDocument$IdentityDocumentFields": "The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
" + } + }, + "IdentityDocumentList": { + "base": null, + "refs": { + "AnalyzeIDResponse$IdentityDocuments": "The list of documents processed by AnalyzeID. Includes a number denoting their place in the list and the response structure for the document.
" + } + }, "ImageBlob": { "base": null, "refs": { @@ -430,6 +480,12 @@ "IdList$member": null } }, + "NormalizedValue": { + "base": "Contains information relating to dates in a document, including the type of value, and the value.
", + "refs": { + "AnalyzeIDDetections$NormalizedValue": "Only returned for dates, returns the type of value detected and the date written in a more machine readable way.
" + } + }, "NotificationChannel": { "base": "The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.
", "refs": { @@ -466,6 +522,7 @@ "Percent": { "base": null, "refs": { + "AnalyzeIDDetections$Confidence": "The confidence score of the detected text.
", "Block$Confidence": "The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
", "ExpenseDetection$Confidence": "The confidence in detection, as a percentage
", "ExpenseType$Confidence": "The confidence of accuracy, as a percentage.
" @@ -593,6 +650,8 @@ "base": null, "refs": { "AnalyzeDocumentResponse$AnalyzeDocumentModelVersion": "The version of the model used to analyze the document.
", + "AnalyzeIDDetections$Text": "Text of either the normalized field or value associated with it.
", + "AnalyzeIDResponse$AnalyzeIDModelVersion": "The version of the AnalyzeIdentity API being used to process documents.
", "Block$Text": "The word or line of text that's recognized by Amazon Textract.
", "DetectDocumentTextResponse$DetectDocumentTextModelVersion": "", "ExpenseDetection$Text": "The word or line of text recognized by Amazon Textract
", @@ -602,7 +661,8 @@ "GetExpenseAnalysisResponse$AnalyzeExpenseModelVersion": "The current model version of AnalyzeExpense.
", "HumanLoopQuotaExceededException$ResourceType": "The resource type.
", "HumanLoopQuotaExceededException$QuotaCode": "The quota code.
", - "HumanLoopQuotaExceededException$ServiceCode": "The service code.
" + "HumanLoopQuotaExceededException$ServiceCode": "The service code.
", + "NormalizedValue$Value": "The value of the date, written as Year-Month-DayTHour:Minute:Second.
" } }, "TextType": { @@ -627,13 +687,20 @@ "DocumentMetadata$Pages": "The number of pages that are detected in the document.
", "ExpenseDocument$ExpenseIndex": "Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.
", "ExpenseField$PageNumber": "The page number the value was detected on.
", + "IdentityDocument$DocumentIndex": "Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
", "LineItemGroup$LineItemGroupIndex": "The number used to identify a specific table in a document. The first table encountered will have a LineItemGroupIndex of 1, the second 2, etc.
", "Pages$member": null } }, "UnsupportedDocumentException": { - "base": "The format of the input document isn't supported. Documents for synchronous operations can be in PNG or JPEG format. Documents for asynchronous operations can also be in PDF format.
", + "base": "The format of the input document isn't supported. Documents for synchronous operations can be in PNG or JPEG format only. Documents for asynchronous operations can be in PDF format.
", + "refs": { + } + }, + "ValueType": { + "base": null, "refs": { + "NormalizedValue$ValueType": "The normalized type of the value detected. In this case, DATE.
" } }, "Warning": { diff --git a/service/migrationhubrefactorspaces/api.go b/service/migrationhubrefactorspaces/api.go new file mode 100644 index 00000000000..29418861e1d --- /dev/null +++ b/service/migrationhubrefactorspaces/api.go @@ -0,0 +1,8619 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package migrationhubrefactorspaces + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opCreateApplication = "CreateApplication" + +// CreateApplicationRequest generates a "aws/request.Request" representing the +// client's request for the CreateApplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateApplication for more information on using the CreateApplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateApplicationRequest method. +// req, resp := client.CreateApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateApplication +func (c *MigrationHubRefactorSpaces) CreateApplicationRequest(input *CreateApplicationInput) (req *request.Request, output *CreateApplicationOutput) { + op := &request.Operation{ + Name: opCreateApplication, + HTTPMethod: "POST", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications", + } + + if input == nil { + input = &CreateApplicationInput{} + } + + output = &CreateApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateApplication API operation for AWS Migration Hub Refactor Spaces. +// +// Creates an Amazon Web Services Migration Hub Refactor Spaces application. +// The account that owns the environment also owns the applications created +// inside the environment, regardless of the account that creates the application. +// Refactor Spaces provisions the Amazon API Gateway and Network Load Balancer +// for the application proxy inside your account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation CreateApplication for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateApplication +func (c *MigrationHubRefactorSpaces) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error) { + req, out := c.CreateApplicationRequest(input) + return out, req.Send() +} + +// CreateApplicationWithContext is the same as CreateApplication with the addition of +// the ability to pass a context and additional request options. +// +// See CreateApplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) CreateApplicationWithContext(ctx aws.Context, input *CreateApplicationInput, opts ...request.Option) (*CreateApplicationOutput, error) { + req, out := c.CreateApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateEnvironment = "CreateEnvironment" + +// CreateEnvironmentRequest generates a "aws/request.Request" representing the +// client's request for the CreateEnvironment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateEnvironment for more information on using the CreateEnvironment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateEnvironmentRequest method. +// req, resp := client.CreateEnvironmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment +func (c *MigrationHubRefactorSpaces) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req *request.Request, output *CreateEnvironmentOutput) { + op := &request.Operation{ + Name: opCreateEnvironment, + HTTPMethod: "POST", + HTTPPath: "/environments", + } + + if input == nil { + input = &CreateEnvironmentInput{} + } + + output = &CreateEnvironmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateEnvironment API operation for AWS Migration Hub Refactor Spaces. +// +// Creates an Amazon Web Services Migration Hub Refactor Spaces environment. +// The caller owns the environment resource, and they are referred to as the +// environment owner. The environment owner has cross-account visibility and +// control of Refactor Spaces resources that are added to the environment by +// other accounts that the environment is shared with. When creating an environment, +// Refactor Spaces provisions a transit gateway in your account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation CreateEnvironment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateEnvironment +func (c *MigrationHubRefactorSpaces) CreateEnvironment(input *CreateEnvironmentInput) (*CreateEnvironmentOutput, error) { + req, out := c.CreateEnvironmentRequest(input) + return out, req.Send() +} + +// CreateEnvironmentWithContext is the same as CreateEnvironment with the addition of +// the ability to pass a context and additional request options. +// +// See CreateEnvironment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) CreateEnvironmentWithContext(ctx aws.Context, input *CreateEnvironmentInput, opts ...request.Option) (*CreateEnvironmentOutput, error) { + req, out := c.CreateEnvironmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateRoute = "CreateRoute" + +// CreateRouteRequest generates a "aws/request.Request" representing the +// client's request for the CreateRoute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateRoute for more information on using the CreateRoute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateRouteRequest method. +// req, resp := client.CreateRouteRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateRoute +func (c *MigrationHubRefactorSpaces) CreateRouteRequest(input *CreateRouteInput) (req *request.Request, output *CreateRouteOutput) { + op := &request.Operation{ + Name: opCreateRoute, + HTTPMethod: "POST", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", + } + + if input == nil { + input = &CreateRouteInput{} + } + + output = &CreateRouteOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateRoute API operation for AWS Migration Hub Refactor Spaces. +// +// Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account +// owner of the service resource is always the environment owner, regardless +// of which account creates the route. Routes target a service in the application. +// If an application does not have any routes, then the first route must be +// created as a DEFAULT RouteType. +// +// When you create a route, Refactor Spaces configures the Amazon API Gateway +// to send traffic to the target service as follows: +// +// * If the service has a URL endpoint, and the endpoint resolves to a private +// IP address, Refactor Spaces routes traffic using the API Gateway VPC link. +// +// * If the service has a URL endpoint, and the endpoint resolves to a public +// IP address, Refactor Spaces routes traffic over the public internet. +// +// * If the service has an Lambda function endpoint, then Refactor Spaces +// uses the API Gateway Lambda integration. +// +// A health check is performed on the service when the route is created. If +// the health check fails, the route transitions to FAILED, and no traffic is +// sent to the service. +// +// For Lambda functions, the Lambda function state is checked. If the function +// is not active, the function configuration is updated so that Lambda resources +// are provisioned. If the Lambda state is Failed, then the route creation fails. +// For more information, see the GetFunctionConfiguration's State response parameter +// (https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) +// in the Lambda Developer Guide. +// +// For public URLs, a connection is opened to the public endpoint. If the URL +// is not reachable, the health check fails. For private URLs, a target group +// is created and the target group health check is run. +// +// The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath are the same +// protocol, port, and path specified in the URL or health URL, if used. All +// other settings use the default values, as described in Health checks for +// your target groups (https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html). +// The health check is considered successful if at least one target within the +// target group transitions to a healthy state. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation CreateRoute for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateRoute +func (c *MigrationHubRefactorSpaces) CreateRoute(input *CreateRouteInput) (*CreateRouteOutput, error) { + req, out := c.CreateRouteRequest(input) + return out, req.Send() +} + +// CreateRouteWithContext is the same as CreateRoute with the addition of +// the ability to pass a context and additional request options. +// +// See CreateRoute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) CreateRouteWithContext(ctx aws.Context, input *CreateRouteInput, opts ...request.Option) (*CreateRouteOutput, error) { + req, out := c.CreateRouteRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateService = "CreateService" + +// CreateServiceRequest generates a "aws/request.Request" representing the +// client's request for the CreateService operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateService for more information on using the CreateService +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateServiceRequest method. +// req, resp := client.CreateServiceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateService +func (c *MigrationHubRefactorSpaces) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput) { + op := &request.Operation{ + Name: opCreateService, + HTTPMethod: "POST", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services", + } + + if input == nil { + input = &CreateServiceInput{} + } + + output = &CreateServiceOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateService API operation for AWS Migration Hub Refactor Spaces. +// +// Creates an Amazon Web Services Migration Hub Refactor Spaces service. The +// account owner of the service is always the environment owner, regardless +// of which account in the environment creates the service. Services have either +// a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint. +// +// If an Amazon Web Services resourceis launched in a service VPC, and you want +// it to be accessible to all of an environment’s services with VPCs and routes, +// apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to +// add more cross-account constraints, apply your own security group. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation CreateService for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/CreateService +func (c *MigrationHubRefactorSpaces) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error) { + req, out := c.CreateServiceRequest(input) + return out, req.Send() +} + +// CreateServiceWithContext is the same as CreateService with the addition of +// the ability to pass a context and additional request options. +// +// See CreateService for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) CreateServiceWithContext(ctx aws.Context, input *CreateServiceInput, opts ...request.Option) (*CreateServiceOutput, error) { + req, out := c.CreateServiceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteApplication = "DeleteApplication" + +// DeleteApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteApplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteApplication for more information on using the DeleteApplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteApplicationRequest method. +// req, resp := client.DeleteApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteApplication +func (c *MigrationHubRefactorSpaces) DeleteApplicationRequest(input *DeleteApplicationInput) (req *request.Request, output *DeleteApplicationOutput) { + op := &request.Operation{ + Name: opDeleteApplication, + HTTPMethod: "DELETE", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}", + } + + if input == nil { + input = &DeleteApplicationInput{} + } + + output = &DeleteApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteApplication API operation for AWS Migration Hub Refactor Spaces. +// +// Deletes an Amazon Web Services Migration Hub Refactor Spaces application. +// Before you can delete an application, you must first delete any services +// or routes within the application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation DeleteApplication for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteApplication +func (c *MigrationHubRefactorSpaces) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error) { + req, out := c.DeleteApplicationRequest(input) + return out, req.Send() +} + +// DeleteApplicationWithContext is the same as DeleteApplication with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteApplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) DeleteApplicationWithContext(ctx aws.Context, input *DeleteApplicationInput, opts ...request.Option) (*DeleteApplicationOutput, error) { + req, out := c.DeleteApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteEnvironment = "DeleteEnvironment" + +// DeleteEnvironmentRequest generates a "aws/request.Request" representing the +// client's request for the DeleteEnvironment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteEnvironment for more information on using the DeleteEnvironment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteEnvironmentRequest method. +// req, resp := client.DeleteEnvironmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment +func (c *MigrationHubRefactorSpaces) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req *request.Request, output *DeleteEnvironmentOutput) { + op := &request.Operation{ + Name: opDeleteEnvironment, + HTTPMethod: "DELETE", + HTTPPath: "/environments/{EnvironmentIdentifier}", + } + + if input == nil { + input = &DeleteEnvironmentInput{} + } + + output = &DeleteEnvironmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteEnvironment API operation for AWS Migration Hub Refactor Spaces. +// +// Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. +// Before you can delete an environment, you must first delete any applications +// and services within the environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation DeleteEnvironment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteEnvironment +func (c *MigrationHubRefactorSpaces) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error) { + req, out := c.DeleteEnvironmentRequest(input) + return out, req.Send() +} + +// DeleteEnvironmentWithContext is the same as DeleteEnvironment with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteEnvironment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) DeleteEnvironmentWithContext(ctx aws.Context, input *DeleteEnvironmentInput, opts ...request.Option) (*DeleteEnvironmentOutput, error) { + req, out := c.DeleteEnvironmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteResourcePolicy = "DeleteResourcePolicy" + +// DeleteResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the DeleteResourcePolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteResourcePolicy for more information on using the DeleteResourcePolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteResourcePolicyRequest method. +// req, resp := client.DeleteResourcePolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy +func (c *MigrationHubRefactorSpaces) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput) { + op := &request.Operation{ + Name: opDeleteResourcePolicy, + HTTPMethod: "DELETE", + HTTPPath: "/resourcepolicy/{Identifier}", + } + + if input == nil { + input = &DeleteResourcePolicyInput{} + } + + output = &DeleteResourcePolicyOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteResourcePolicy API operation for AWS Migration Hub Refactor Spaces. +// +// Deletes the resource policy set for the environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation DeleteResourcePolicy for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteResourcePolicy +func (c *MigrationHubRefactorSpaces) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error) { + req, out := c.DeleteResourcePolicyRequest(input) + return out, req.Send() +} + +// DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteResourcePolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error) { + req, out := c.DeleteResourcePolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteRoute = "DeleteRoute" + +// DeleteRouteRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRoute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteRoute for more information on using the DeleteRoute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteRouteRequest method. +// req, resp := client.DeleteRouteRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteRoute +func (c *MigrationHubRefactorSpaces) DeleteRouteRequest(input *DeleteRouteInput) (req *request.Request, output *DeleteRouteOutput) { + op := &request.Operation{ + Name: opDeleteRoute, + HTTPMethod: "DELETE", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", + } + + if input == nil { + input = &DeleteRouteInput{} + } + + output = &DeleteRouteOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteRoute API operation for AWS Migration Hub Refactor Spaces. +// +// Deletes an Amazon Web Services Migration Hub Refactor Spaces route. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation DeleteRoute for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteRoute +func (c *MigrationHubRefactorSpaces) DeleteRoute(input *DeleteRouteInput) (*DeleteRouteOutput, error) { + req, out := c.DeleteRouteRequest(input) + return out, req.Send() +} + +// DeleteRouteWithContext is the same as DeleteRoute with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRoute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) DeleteRouteWithContext(ctx aws.Context, input *DeleteRouteInput, opts ...request.Option) (*DeleteRouteOutput, error) { + req, out := c.DeleteRouteRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteService = "DeleteService" + +// DeleteServiceRequest generates a "aws/request.Request" representing the +// client's request for the DeleteService operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteService for more information on using the DeleteService +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteServiceRequest method. +// req, resp := client.DeleteServiceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteService +func (c *MigrationHubRefactorSpaces) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput) { + op := &request.Operation{ + Name: opDeleteService, + HTTPMethod: "DELETE", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services/{ServiceIdentifier}", + } + + if input == nil { + input = &DeleteServiceInput{} + } + + output = &DeleteServiceOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteService API operation for AWS Migration Hub Refactor Spaces. +// +// Deletes an Amazon Web Services Migration Hub Refactor Spaces service. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation DeleteService for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/DeleteService +func (c *MigrationHubRefactorSpaces) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error) { + req, out := c.DeleteServiceRequest(input) + return out, req.Send() +} + +// DeleteServiceWithContext is the same as DeleteService with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteService for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) DeleteServiceWithContext(ctx aws.Context, input *DeleteServiceInput, opts ...request.Option) (*DeleteServiceOutput, error) { + req, out := c.DeleteServiceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetApplication = "GetApplication" + +// GetApplicationRequest generates a "aws/request.Request" representing the +// client's request for the GetApplication operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetApplication for more information on using the GetApplication +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetApplicationRequest method. +// req, resp := client.GetApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetApplication +func (c *MigrationHubRefactorSpaces) GetApplicationRequest(input *GetApplicationInput) (req *request.Request, output *GetApplicationOutput) { + op := &request.Operation{ + Name: opGetApplication, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}", + } + + if input == nil { + input = &GetApplicationInput{} + } + + output = &GetApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetApplication API operation for AWS Migration Hub Refactor Spaces. +// +// Gets an Amazon Web Services Migration Hub Refactor Spaces application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation GetApplication for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetApplication +func (c *MigrationHubRefactorSpaces) GetApplication(input *GetApplicationInput) (*GetApplicationOutput, error) { + req, out := c.GetApplicationRequest(input) + return out, req.Send() +} + +// GetApplicationWithContext is the same as GetApplication with the addition of +// the ability to pass a context and additional request options. +// +// See GetApplication for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) GetApplicationWithContext(ctx aws.Context, input *GetApplicationInput, opts ...request.Option) (*GetApplicationOutput, error) { + req, out := c.GetApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetEnvironment = "GetEnvironment" + +// GetEnvironmentRequest generates a "aws/request.Request" representing the +// client's request for the GetEnvironment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEnvironment for more information on using the GetEnvironment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEnvironmentRequest method. +// req, resp := client.GetEnvironmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetEnvironment +func (c *MigrationHubRefactorSpaces) GetEnvironmentRequest(input *GetEnvironmentInput) (req *request.Request, output *GetEnvironmentOutput) { + op := &request.Operation{ + Name: opGetEnvironment, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}", + } + + if input == nil { + input = &GetEnvironmentInput{} + } + + output = &GetEnvironmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEnvironment API operation for AWS Migration Hub Refactor Spaces. +// +// Gets an Amazon Web Services Migration Hub Refactor Spaces environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation GetEnvironment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetEnvironment +func (c *MigrationHubRefactorSpaces) GetEnvironment(input *GetEnvironmentInput) (*GetEnvironmentOutput, error) { + req, out := c.GetEnvironmentRequest(input) + return out, req.Send() +} + +// GetEnvironmentWithContext is the same as GetEnvironment with the addition of +// the ability to pass a context and additional request options. +// +// See GetEnvironment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) GetEnvironmentWithContext(ctx aws.Context, input *GetEnvironmentInput, opts ...request.Option) (*GetEnvironmentOutput, error) { + req, out := c.GetEnvironmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetResourcePolicy = "GetResourcePolicy" + +// GetResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the GetResourcePolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetResourcePolicy for more information on using the GetResourcePolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetResourcePolicyRequest method. +// req, resp := client.GetResourcePolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy +func (c *MigrationHubRefactorSpaces) GetResourcePolicyRequest(input *GetResourcePolicyInput) (req *request.Request, output *GetResourcePolicyOutput) { + op := &request.Operation{ + Name: opGetResourcePolicy, + HTTPMethod: "GET", + HTTPPath: "/resourcepolicy/{Identifier}", + } + + if input == nil { + input = &GetResourcePolicyInput{} + } + + output = &GetResourcePolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetResourcePolicy API operation for AWS Migration Hub Refactor Spaces. +// +// Gets the resource-based permission policy that is set for the given environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation GetResourcePolicy for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetResourcePolicy +func (c *MigrationHubRefactorSpaces) GetResourcePolicy(input *GetResourcePolicyInput) (*GetResourcePolicyOutput, error) { + req, out := c.GetResourcePolicyRequest(input) + return out, req.Send() +} + +// GetResourcePolicyWithContext is the same as GetResourcePolicy with the addition of +// the ability to pass a context and additional request options. +// +// See GetResourcePolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) GetResourcePolicyWithContext(ctx aws.Context, input *GetResourcePolicyInput, opts ...request.Option) (*GetResourcePolicyOutput, error) { + req, out := c.GetResourcePolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetRoute = "GetRoute" + +// GetRouteRequest generates a "aws/request.Request" representing the +// client's request for the GetRoute operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetRoute for more information on using the GetRoute +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetRouteRequest method. +// req, resp := client.GetRouteRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetRoute +func (c *MigrationHubRefactorSpaces) GetRouteRequest(input *GetRouteInput) (req *request.Request, output *GetRouteOutput) { + op := &request.Operation{ + Name: opGetRoute, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes/{RouteIdentifier}", + } + + if input == nil { + input = &GetRouteInput{} + } + + output = &GetRouteOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetRoute API operation for AWS Migration Hub Refactor Spaces. +// +// Gets an Amazon Web Services Migration Hub Refactor Spaces route. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation GetRoute for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetRoute +func (c *MigrationHubRefactorSpaces) GetRoute(input *GetRouteInput) (*GetRouteOutput, error) { + req, out := c.GetRouteRequest(input) + return out, req.Send() +} + +// GetRouteWithContext is the same as GetRoute with the addition of +// the ability to pass a context and additional request options. +// +// See GetRoute for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) GetRouteWithContext(ctx aws.Context, input *GetRouteInput, opts ...request.Option) (*GetRouteOutput, error) { + req, out := c.GetRouteRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetService = "GetService" + +// GetServiceRequest generates a "aws/request.Request" representing the +// client's request for the GetService operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetService for more information on using the GetService +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetServiceRequest method. +// req, resp := client.GetServiceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetService +func (c *MigrationHubRefactorSpaces) GetServiceRequest(input *GetServiceInput) (req *request.Request, output *GetServiceOutput) { + op := &request.Operation{ + Name: opGetService, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services/{ServiceIdentifier}", + } + + if input == nil { + input = &GetServiceInput{} + } + + output = &GetServiceOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetService API operation for AWS Migration Hub Refactor Spaces. +// +// Gets an Amazon Web Services Migration Hub Refactor Spaces service. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation GetService for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/GetService +func (c *MigrationHubRefactorSpaces) GetService(input *GetServiceInput) (*GetServiceOutput, error) { + req, out := c.GetServiceRequest(input) + return out, req.Send() +} + +// GetServiceWithContext is the same as GetService with the addition of +// the ability to pass a context and additional request options. +// +// See GetService for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) GetServiceWithContext(ctx aws.Context, input *GetServiceInput, opts ...request.Option) (*GetServiceOutput, error) { + req, out := c.GetServiceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListApplications = "ListApplications" + +// ListApplicationsRequest generates a "aws/request.Request" representing the +// client's request for the ListApplications operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListApplications for more information on using the ListApplications +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListApplicationsRequest method. +// req, resp := client.ListApplicationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListApplications +func (c *MigrationHubRefactorSpaces) ListApplicationsRequest(input *ListApplicationsInput) (req *request.Request, output *ListApplicationsOutput) { + op := &request.Operation{ + Name: opListApplications, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListApplicationsInput{} + } + + output = &ListApplicationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApplications API operation for AWS Migration Hub Refactor Spaces. +// +// Lists all the Amazon Web Services Migration Hub Refactor Spaces applications +// within an environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListApplications for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListApplications +func (c *MigrationHubRefactorSpaces) ListApplications(input *ListApplicationsInput) (*ListApplicationsOutput, error) { + req, out := c.ListApplicationsRequest(input) + return out, req.Send() +} + +// ListApplicationsWithContext is the same as ListApplications with the addition of +// the ability to pass a context and additional request options. +// +// See ListApplications for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListApplicationsWithContext(ctx aws.Context, input *ListApplicationsInput, opts ...request.Option) (*ListApplicationsOutput, error) { + req, out := c.ListApplicationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListApplicationsPages iterates over the pages of a ListApplications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplications method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplications operation. +// pageNum := 0 +// err := client.ListApplicationsPages(params, +// func(page *migrationhubrefactorspaces.ListApplicationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *MigrationHubRefactorSpaces) ListApplicationsPages(input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool) error { + return c.ListApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationsPagesWithContext same as ListApplicationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListApplicationsPagesWithContext(ctx aws.Context, input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListEnvironmentVpcs = "ListEnvironmentVpcs" + +// ListEnvironmentVpcsRequest generates a "aws/request.Request" representing the +// client's request for the ListEnvironmentVpcs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListEnvironmentVpcs for more information on using the ListEnvironmentVpcs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListEnvironmentVpcsRequest method. +// req, resp := client.ListEnvironmentVpcsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs +func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcsRequest(input *ListEnvironmentVpcsInput) (req *request.Request, output *ListEnvironmentVpcsOutput) { + op := &request.Operation{ + Name: opListEnvironmentVpcs, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/vpcs", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListEnvironmentVpcsInput{} + } + + output = &ListEnvironmentVpcsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListEnvironmentVpcs API operation for AWS Migration Hub Refactor Spaces. +// +// Lists all the virtual private clouds (VPCs) that are part of an Amazon Web +// Services Migration Hub Refactor Spaces environment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListEnvironmentVpcs for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListEnvironmentVpcs +func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcs(input *ListEnvironmentVpcsInput) (*ListEnvironmentVpcsOutput, error) { + req, out := c.ListEnvironmentVpcsRequest(input) + return out, req.Send() +} + +// ListEnvironmentVpcsWithContext is the same as ListEnvironmentVpcs with the addition of +// the ability to pass a context and additional request options. +// +// See ListEnvironmentVpcs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcsWithContext(ctx aws.Context, input *ListEnvironmentVpcsInput, opts ...request.Option) (*ListEnvironmentVpcsOutput, error) { + req, out := c.ListEnvironmentVpcsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListEnvironmentVpcsPages iterates over the pages of a ListEnvironmentVpcs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListEnvironmentVpcs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListEnvironmentVpcs operation. +// pageNum := 0 +// err := client.ListEnvironmentVpcsPages(params, +// func(page *migrationhubrefactorspaces.ListEnvironmentVpcsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcsPages(input *ListEnvironmentVpcsInput, fn func(*ListEnvironmentVpcsOutput, bool) bool) error { + return c.ListEnvironmentVpcsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListEnvironmentVpcsPagesWithContext same as ListEnvironmentVpcsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListEnvironmentVpcsPagesWithContext(ctx aws.Context, input *ListEnvironmentVpcsInput, fn func(*ListEnvironmentVpcsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListEnvironmentVpcsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListEnvironmentVpcsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListEnvironmentVpcsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListEnvironments = "ListEnvironments" + +// ListEnvironmentsRequest generates a "aws/request.Request" representing the +// client's request for the ListEnvironments operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListEnvironments for more information on using the ListEnvironments +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListEnvironmentsRequest method. +// req, resp := client.ListEnvironmentsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListEnvironments +func (c *MigrationHubRefactorSpaces) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req *request.Request, output *ListEnvironmentsOutput) { + op := &request.Operation{ + Name: opListEnvironments, + HTTPMethod: "GET", + HTTPPath: "/environments", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListEnvironmentsInput{} + } + + output = &ListEnvironmentsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListEnvironments API operation for AWS Migration Hub Refactor Spaces. +// +// Lists Amazon Web Services Migration Hub Refactor Spaces environments owned +// by a caller account or shared with the caller account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListEnvironments for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListEnvironments +func (c *MigrationHubRefactorSpaces) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error) { + req, out := c.ListEnvironmentsRequest(input) + return out, req.Send() +} + +// ListEnvironmentsWithContext is the same as ListEnvironments with the addition of +// the ability to pass a context and additional request options. +// +// See ListEnvironments for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListEnvironmentsWithContext(ctx aws.Context, input *ListEnvironmentsInput, opts ...request.Option) (*ListEnvironmentsOutput, error) { + req, out := c.ListEnvironmentsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListEnvironmentsPages iterates over the pages of a ListEnvironments operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListEnvironments method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListEnvironments operation. +// pageNum := 0 +// err := client.ListEnvironmentsPages(params, +// func(page *migrationhubrefactorspaces.ListEnvironmentsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *MigrationHubRefactorSpaces) ListEnvironmentsPages(input *ListEnvironmentsInput, fn func(*ListEnvironmentsOutput, bool) bool) error { + return c.ListEnvironmentsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListEnvironmentsPagesWithContext same as ListEnvironmentsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListEnvironmentsPagesWithContext(ctx aws.Context, input *ListEnvironmentsInput, fn func(*ListEnvironmentsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListEnvironmentsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListEnvironmentsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListEnvironmentsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRoutes = "ListRoutes" + +// ListRoutesRequest generates a "aws/request.Request" representing the +// client's request for the ListRoutes operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListRoutes for more information on using the ListRoutes +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListRoutesRequest method. +// req, resp := client.ListRoutesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListRoutes +func (c *MigrationHubRefactorSpaces) ListRoutesRequest(input *ListRoutesInput) (req *request.Request, output *ListRoutesOutput) { + op := &request.Operation{ + Name: opListRoutes, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/routes", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRoutesInput{} + } + + output = &ListRoutesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRoutes API operation for AWS Migration Hub Refactor Spaces. +// +// Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within +// an application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListRoutes for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListRoutes +func (c *MigrationHubRefactorSpaces) ListRoutes(input *ListRoutesInput) (*ListRoutesOutput, error) { + req, out := c.ListRoutesRequest(input) + return out, req.Send() +} + +// ListRoutesWithContext is the same as ListRoutes with the addition of +// the ability to pass a context and additional request options. +// +// See ListRoutes for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListRoutesWithContext(ctx aws.Context, input *ListRoutesInput, opts ...request.Option) (*ListRoutesOutput, error) { + req, out := c.ListRoutesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRoutesPages iterates over the pages of a ListRoutes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRoutes method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRoutes operation. +// pageNum := 0 +// err := client.ListRoutesPages(params, +// func(page *migrationhubrefactorspaces.ListRoutesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *MigrationHubRefactorSpaces) ListRoutesPages(input *ListRoutesInput, fn func(*ListRoutesOutput, bool) bool) error { + return c.ListRoutesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRoutesPagesWithContext same as ListRoutesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListRoutesPagesWithContext(ctx aws.Context, input *ListRoutesInput, fn func(*ListRoutesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRoutesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRoutesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRoutesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListServices = "ListServices" + +// ListServicesRequest generates a "aws/request.Request" representing the +// client's request for the ListServices operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListServices for more information on using the ListServices +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListServicesRequest method. +// req, resp := client.ListServicesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListServices +func (c *MigrationHubRefactorSpaces) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput) { + op := &request.Operation{ + Name: opListServices, + HTTPMethod: "GET", + HTTPPath: "/environments/{EnvironmentIdentifier}/applications/{ApplicationIdentifier}/services", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListServicesInput{} + } + + output = &ListServicesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListServices API operation for AWS Migration Hub Refactor Spaces. +// +// Lists all the Amazon Web Services Migration Hub Refactor Spaces services +// within an application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListServices for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// The request would cause a service quota to be exceeded. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListServices +func (c *MigrationHubRefactorSpaces) ListServices(input *ListServicesInput) (*ListServicesOutput, error) { + req, out := c.ListServicesRequest(input) + return out, req.Send() +} + +// ListServicesWithContext is the same as ListServices with the addition of +// the ability to pass a context and additional request options. +// +// See ListServices for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListServicesWithContext(ctx aws.Context, input *ListServicesInput, opts ...request.Option) (*ListServicesOutput, error) { + req, out := c.ListServicesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListServicesPages iterates over the pages of a ListServices operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListServices method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListServices operation. +// pageNum := 0 +// err := client.ListServicesPages(params, +// func(page *migrationhubrefactorspaces.ListServicesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *MigrationHubRefactorSpaces) ListServicesPages(input *ListServicesInput, fn func(*ListServicesOutput, bool) bool) error { + return c.ListServicesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListServicesPagesWithContext same as ListServicesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListServicesPagesWithContext(ctx aws.Context, input *ListServicesInput, fn func(*ListServicesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListServicesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListServicesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListServicesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource +func (c *MigrationHubRefactorSpaces) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Migration Hub Refactor Spaces. +// +// Lists the tags of a resource. The caller account must be the same as the +// resource’s OwnerAccountId. Listing tags in other accounts is not supported. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/ListTagsForResource +func (c *MigrationHubRefactorSpaces) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opPutResourcePolicy = "PutResourcePolicy" + +// PutResourcePolicyRequest generates a "aws/request.Request" representing the +// client's request for the PutResourcePolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See PutResourcePolicy for more information on using the PutResourcePolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the PutResourcePolicyRequest method. +// req, resp := client.PutResourcePolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy +func (c *MigrationHubRefactorSpaces) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput) { + op := &request.Operation{ + Name: opPutResourcePolicy, + HTTPMethod: "PUT", + HTTPPath: "/resourcepolicy", + } + + if input == nil { + input = &PutResourcePolicyInput{} + } + + output = &PutResourcePolicyOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// PutResourcePolicy API operation for AWS Migration Hub Refactor Spaces. +// +// Attaches a resource-based permission policy to the Amazon Web Services Migration +// Hub Refactor Spaces environment. The policy must contain the same actions +// and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment +// permission in Resource Access Manager. The policy must not contain new lines +// or blank lines. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation PutResourcePolicy for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * InvalidResourcePolicyException +// The resource policy is not valid. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// * ThrottlingException +// Request was denied because the request was throttled. +// +// * AccessDeniedException +// The user does not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/PutResourcePolicy +func (c *MigrationHubRefactorSpaces) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error) { + req, out := c.PutResourcePolicyRequest(input) + return out, req.Send() +} + +// PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of +// the ability to pass a context and additional request options. +// +// See PutResourcePolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error) { + req, out := c.PutResourcePolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/TagResource +func (c *MigrationHubRefactorSpaces) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS Migration Hub Refactor Spaces. +// +// Removes the tags of a given resource. Tags are metadata which can be used +// to manage a resource. To tag a resource, the caller account must be the same +// as the resource’s OwnerAccountId. Tagging resources in other accounts is +// not supported. +// +// Amazon Web Services Migration Hub Refactor Spaces does not propagate tags +// to orchestrated resources, such as an environment’s transit gateway. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/TagResource +func (c *MigrationHubRefactorSpaces) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/UntagResource +func (c *MigrationHubRefactorSpaces) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS Migration Hub Refactor Spaces. +// +// Adds to or modifies the tags of the given resource. Tags are metadata which +// can be used to manage a resource. To untag a resource, the caller account +// must be the same as the resource’s OwnerAccountId. Untagging resources +// across accounts is not supported. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Migration Hub Refactor Spaces's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The request references a resource that does not exist. +// +// * InternalServerException +// An unexpected error occurred while processing the request. +// +// * ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Service. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26/UntagResource +func (c *MigrationHubRefactorSpaces) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *MigrationHubRefactorSpaces) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The user does not have sufficient access to perform this action. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A wrapper object holding the Amazon API Gateway proxy configuration. +type ApiGatewayProxyConfig struct { + _ struct{} `type:"structure"` + + // The resource ID of the API Gateway for the proxy. + ApiGatewayId *string `min:"10" type:"string"` + + // The type of API Gateway endpoint created. + EndpointType *string `type:"string" enum:"ApiGatewayEndpointType"` + + // The Amazon Resource Name (ARN) of the Network Load Balancer configured by + // the API Gateway proxy. + NlbArn *string `min:"20" type:"string"` + + // The name of the Network Load Balancer that is configured by the API Gateway + // proxy. + NlbName *string `min:"1" type:"string"` + + // The endpoint URL of the API Gateway proxy. + ProxyUrl *string `min:"1" type:"string"` + + // The name of the API Gateway stage. The name defaults to prod. + StageName *string `min:"1" type:"string"` + + // The VpcLink ID of the API Gateway proxy. + VpcLinkId *string `min:"10" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxyConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxyConfig) GoString() string { + return s.String() +} + +// SetApiGatewayId sets the ApiGatewayId field's value. +func (s *ApiGatewayProxyConfig) SetApiGatewayId(v string) *ApiGatewayProxyConfig { + s.ApiGatewayId = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *ApiGatewayProxyConfig) SetEndpointType(v string) *ApiGatewayProxyConfig { + s.EndpointType = &v + return s +} + +// SetNlbArn sets the NlbArn field's value. +func (s *ApiGatewayProxyConfig) SetNlbArn(v string) *ApiGatewayProxyConfig { + s.NlbArn = &v + return s +} + +// SetNlbName sets the NlbName field's value. +func (s *ApiGatewayProxyConfig) SetNlbName(v string) *ApiGatewayProxyConfig { + s.NlbName = &v + return s +} + +// SetProxyUrl sets the ProxyUrl field's value. +func (s *ApiGatewayProxyConfig) SetProxyUrl(v string) *ApiGatewayProxyConfig { + s.ProxyUrl = &v + return s +} + +// SetStageName sets the StageName field's value. +func (s *ApiGatewayProxyConfig) SetStageName(v string) *ApiGatewayProxyConfig { + s.StageName = &v + return s +} + +// SetVpcLinkId sets the VpcLinkId field's value. +func (s *ApiGatewayProxyConfig) SetVpcLinkId(v string) *ApiGatewayProxyConfig { + s.VpcLinkId = &v + return s +} + +// A wrapper object holding the Amazon API Gateway endpoint input. +type ApiGatewayProxyInput_ struct { + _ struct{} `type:"structure"` + + // The type of endpoint to use for the API Gateway proxy. If no value is specified + // in the request, the value is set to REGIONAL by default. + // + // If the value is set to PRIVATE in the request, this creates a private API + // endpoint that is isolated from the public internet. The private endpoint + // can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints + // for Amazon API Gateway that have been granted access. + EndpointType *string `type:"string" enum:"ApiGatewayEndpointType"` + + // The name of the API Gateway stage. The name defaults to prod. + StageName *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxyInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxyInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ApiGatewayProxyInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ApiGatewayProxyInput_"} + if s.StageName != nil && len(*s.StageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StageName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndpointType sets the EndpointType field's value. +func (s *ApiGatewayProxyInput_) SetEndpointType(v string) *ApiGatewayProxyInput_ { + s.EndpointType = &v + return s +} + +// SetStageName sets the StageName field's value. +func (s *ApiGatewayProxyInput_) SetStageName(v string) *ApiGatewayProxyInput_ { + s.StageName = &v + return s +} + +// A wrapper object holding the Amazon API Gateway proxy summary. +type ApiGatewayProxySummary struct { + _ struct{} `type:"structure"` + + // The resource ID of the API Gateway for the proxy. + ApiGatewayId *string `min:"10" type:"string"` + + // The type of API Gateway endpoint created. + EndpointType *string `type:"string" enum:"ApiGatewayEndpointType"` + + // The Amazon Resource Name (ARN) of the Network Load Balancer configured by + // the API Gateway proxy. + NlbArn *string `min:"20" type:"string"` + + // The name of the Network Load Balancer that is configured by the API Gateway + // proxy. + NlbName *string `min:"1" type:"string"` + + // The endpoint URL of the API Gateway proxy. + ProxyUrl *string `min:"1" type:"string"` + + // The name of the API Gateway stage. The name defaults to prod. + StageName *string `min:"1" type:"string"` + + // The VpcLink ID of the API Gateway proxy. + VpcLinkId *string `min:"10" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxySummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApiGatewayProxySummary) GoString() string { + return s.String() +} + +// SetApiGatewayId sets the ApiGatewayId field's value. +func (s *ApiGatewayProxySummary) SetApiGatewayId(v string) *ApiGatewayProxySummary { + s.ApiGatewayId = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *ApiGatewayProxySummary) SetEndpointType(v string) *ApiGatewayProxySummary { + s.EndpointType = &v + return s +} + +// SetNlbArn sets the NlbArn field's value. +func (s *ApiGatewayProxySummary) SetNlbArn(v string) *ApiGatewayProxySummary { + s.NlbArn = &v + return s +} + +// SetNlbName sets the NlbName field's value. +func (s *ApiGatewayProxySummary) SetNlbName(v string) *ApiGatewayProxySummary { + s.NlbName = &v + return s +} + +// SetProxyUrl sets the ProxyUrl field's value. +func (s *ApiGatewayProxySummary) SetProxyUrl(v string) *ApiGatewayProxySummary { + s.ProxyUrl = &v + return s +} + +// SetStageName sets the StageName field's value. +func (s *ApiGatewayProxySummary) SetStageName(v string) *ApiGatewayProxySummary { + s.StageName = &v + return s +} + +// SetVpcLinkId sets the VpcLinkId field's value. +func (s *ApiGatewayProxySummary) SetVpcLinkId(v string) *ApiGatewayProxySummary { + s.VpcLinkId = &v + return s +} + +// The list of ApplicationSummary objects. +type ApplicationSummary struct { + _ struct{} `type:"structure"` + + // The endpoint URL of the Amazon API Gateway proxy. + ApiGatewayProxy *ApiGatewayProxySummary `type:"structure"` + + // The unique identifier of the application. + ApplicationId *string `min:"14" type:"string"` + + // he Amazon Resource Name (ARN) of the application. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the application creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the application is created. + CreatedTime *time.Time `type:"timestamp"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the application resource. + Error *ErrorResponse `type:"structure"` + + // A timestamp that indicates when the application was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the application. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the application owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The proxy type of the proxy created within the application. + ProxyType *string `type:"string" enum:"ProxyType"` + + // The current state of the application. + State *string `type:"string" enum:"ApplicationState"` + + // The tags assigned to the application. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ApplicationSummary's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the virtual private cloud (VPC). + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSummary) GoString() string { + return s.String() +} + +// SetApiGatewayProxy sets the ApiGatewayProxy field's value. +func (s *ApplicationSummary) SetApiGatewayProxy(v *ApiGatewayProxySummary) *ApplicationSummary { + s.ApiGatewayProxy = v + return s +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *ApplicationSummary) SetApplicationId(v string) *ApplicationSummary { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *ApplicationSummary) SetArn(v string) *ApplicationSummary { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *ApplicationSummary) SetCreatedByAccountId(v string) *ApplicationSummary { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *ApplicationSummary) SetCreatedTime(v time.Time) *ApplicationSummary { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *ApplicationSummary) SetEnvironmentId(v string) *ApplicationSummary { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *ApplicationSummary) SetError(v *ErrorResponse) *ApplicationSummary { + s.Error = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *ApplicationSummary) SetLastUpdatedTime(v time.Time) *ApplicationSummary { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *ApplicationSummary) SetName(v string) *ApplicationSummary { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *ApplicationSummary) SetOwnerAccountId(v string) *ApplicationSummary { + s.OwnerAccountId = &v + return s +} + +// SetProxyType sets the ProxyType field's value. +func (s *ApplicationSummary) SetProxyType(v string) *ApplicationSummary { + s.ProxyType = &v + return s +} + +// SetState sets the State field's value. +func (s *ApplicationSummary) SetState(v string) *ApplicationSummary { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ApplicationSummary) SetTags(v map[string]*string) *ApplicationSummary { + s.Tags = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *ApplicationSummary) SetVpcId(v string) *ApplicationSummary { + s.VpcId = &v + return s +} + +// Updating or deleting a resource can cause an inconsistent state. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The ID of the resource. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The type of resource. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateApplicationInput struct { + _ struct{} `type:"structure"` + + // A wrapper object holding the API Gateway endpoint type and stage name for + // the proxy. + ApiGatewayProxy *ApiGatewayProxyInput_ `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The unique identifier of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The name to use for the application. + // + // Name is a required field + Name *string `min:"3" type:"string" required:"true"` + + // The proxy type of the proxy created within the application. + // + // ProxyType is a required field + ProxyType *string `type:"string" required:"true" enum:"ProxyType"` + + // The tags to assign to the application. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateApplicationInput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the virtual private cloud (VPC). + // + // VpcId is a required field + VpcId *string `min:"12" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateApplicationInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } + if s.ProxyType == nil { + invalidParams.Add(request.NewErrParamRequired("ProxyType")) + } + if s.VpcId == nil { + invalidParams.Add(request.NewErrParamRequired("VpcId")) + } + if s.VpcId != nil && len(*s.VpcId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("VpcId", 12)) + } + if s.ApiGatewayProxy != nil { + if err := s.ApiGatewayProxy.Validate(); err != nil { + invalidParams.AddNested("ApiGatewayProxy", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApiGatewayProxy sets the ApiGatewayProxy field's value. +func (s *CreateApplicationInput) SetApiGatewayProxy(v *ApiGatewayProxyInput_) *CreateApplicationInput { + s.ApiGatewayProxy = v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateApplicationInput) SetClientToken(v string) *CreateApplicationInput { + s.ClientToken = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *CreateApplicationInput) SetEnvironmentIdentifier(v string) *CreateApplicationInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateApplicationInput) SetName(v string) *CreateApplicationInput { + s.Name = &v + return s +} + +// SetProxyType sets the ProxyType field's value. +func (s *CreateApplicationInput) SetProxyType(v string) *CreateApplicationInput { + s.ProxyType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateApplicationInput) SetTags(v map[string]*string) *CreateApplicationInput { + s.Tags = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *CreateApplicationInput) SetVpcId(v string) *CreateApplicationInput { + s.VpcId = &v + return s +} + +type CreateApplicationOutput struct { + _ struct{} `type:"structure"` + + // A wrapper object holding the API Gateway endpoint type and stage name for + // the proxy. + ApiGatewayProxy *ApiGatewayProxyInput_ `type:"structure"` + + // The unique identifier of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the application. The format for this ARN + // is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . + // For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of application creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the application is created. + CreatedTime *time.Time `type:"timestamp"` + + // The ID of the environment in which the application is created. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the application was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the application. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the application owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The proxy type of the proxy created within the application. + ProxyType *string `type:"string" enum:"ProxyType"` + + // The current state of the application. + State *string `type:"string" enum:"ApplicationState"` + + // The tags assigned to the application. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateApplicationOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the Amazon VPC. + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateApplicationOutput) GoString() string { + return s.String() +} + +// SetApiGatewayProxy sets the ApiGatewayProxy field's value. +func (s *CreateApplicationOutput) SetApiGatewayProxy(v *ApiGatewayProxyInput_) *CreateApplicationOutput { + s.ApiGatewayProxy = v + return s +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *CreateApplicationOutput) SetApplicationId(v string) *CreateApplicationOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *CreateApplicationOutput) SetArn(v string) *CreateApplicationOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *CreateApplicationOutput) SetCreatedByAccountId(v string) *CreateApplicationOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *CreateApplicationOutput) SetCreatedTime(v time.Time) *CreateApplicationOutput { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *CreateApplicationOutput) SetEnvironmentId(v string) *CreateApplicationOutput { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *CreateApplicationOutput) SetLastUpdatedTime(v time.Time) *CreateApplicationOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateApplicationOutput) SetName(v string) *CreateApplicationOutput { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *CreateApplicationOutput) SetOwnerAccountId(v string) *CreateApplicationOutput { + s.OwnerAccountId = &v + return s +} + +// SetProxyType sets the ProxyType field's value. +func (s *CreateApplicationOutput) SetProxyType(v string) *CreateApplicationOutput { + s.ProxyType = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateApplicationOutput) SetState(v string) *CreateApplicationOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateApplicationOutput) SetTags(v map[string]*string) *CreateApplicationOutput { + s.Tags = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *CreateApplicationOutput) SetVpcId(v string) *CreateApplicationOutput { + s.VpcId = &v + return s +} + +type CreateEnvironmentInput struct { + _ struct{} `type:"structure"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The description of the environment. + Description *string `min:"1" type:"string"` + + // The name of the environment. + // + // Name is a required field + Name *string `min:"3" type:"string" required:"true"` + + // The network fabric type of the environment. + // + // NetworkFabricType is a required field + NetworkFabricType *string `type:"string" required:"true" enum:"NetworkFabricType"` + + // The tags to assign to the environment. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateEnvironmentInput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEnvironmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEnvironmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateEnvironmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateEnvironmentInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } + if s.NetworkFabricType == nil { + invalidParams.Add(request.NewErrParamRequired("NetworkFabricType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateEnvironmentInput) SetClientToken(v string) *CreateEnvironmentInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateEnvironmentInput) SetDescription(v string) *CreateEnvironmentInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateEnvironmentInput) SetName(v string) *CreateEnvironmentInput { + s.Name = &v + return s +} + +// SetNetworkFabricType sets the NetworkFabricType field's value. +func (s *CreateEnvironmentInput) SetNetworkFabricType(v string) *CreateEnvironmentInput { + s.NetworkFabricType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateEnvironmentInput) SetTags(v map[string]*string) *CreateEnvironmentInput { + s.Tags = v + return s +} + +type CreateEnvironmentOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the environment. + Arn *string `min:"20" type:"string"` + + // A timestamp that indicates when the environment is created. + CreatedTime *time.Time `type:"timestamp"` + + // A description of the environment. + Description *string `min:"1" type:"string"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the environment was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the environment. + Name *string `min:"3" type:"string"` + + // The network fabric type of the environment. + NetworkFabricType *string `type:"string" enum:"NetworkFabricType"` + + // The Amazon Web Services account ID of environment owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The current state of the environment. + State *string `type:"string" enum:"EnvironmentState"` + + // The tags assigned to the created environment. A tag is a label that you assign + // to an Amazon Web Services resource. Each tag consists of a key-value pair.. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateEnvironmentOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEnvironmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateEnvironmentOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateEnvironmentOutput) SetArn(v string) *CreateEnvironmentOutput { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *CreateEnvironmentOutput) SetCreatedTime(v time.Time) *CreateEnvironmentOutput { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateEnvironmentOutput) SetDescription(v string) *CreateEnvironmentOutput { + s.Description = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *CreateEnvironmentOutput) SetEnvironmentId(v string) *CreateEnvironmentOutput { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *CreateEnvironmentOutput) SetLastUpdatedTime(v time.Time) *CreateEnvironmentOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateEnvironmentOutput) SetName(v string) *CreateEnvironmentOutput { + s.Name = &v + return s +} + +// SetNetworkFabricType sets the NetworkFabricType field's value. +func (s *CreateEnvironmentOutput) SetNetworkFabricType(v string) *CreateEnvironmentOutput { + s.NetworkFabricType = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *CreateEnvironmentOutput) SetOwnerAccountId(v string) *CreateEnvironmentOutput { + s.OwnerAccountId = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateEnvironmentOutput) SetState(v string) *CreateEnvironmentOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateEnvironmentOutput) SetTags(v map[string]*string) *CreateEnvironmentOutput { + s.Tags = v + return s +} + +type CreateRouteInput struct { + _ struct{} `type:"structure"` + + // The ID of the application within which the route is being created. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The ID of the environment in which the route is created. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The route type of the route. DEFAULT indicates that all traffic that does + // not match another route is forwarded to the default route. Applications must + // have a default route before any other routes can be created. URI_PATH indicates + // a route that is based on a URI path. + // + // RouteType is a required field + RouteType *string `type:"string" required:"true" enum:"RouteType"` + + // The ID of the service in which the route is created. Traffic that matches + // this route is forwarded to this service. + // + // ServiceIdentifier is a required field + ServiceIdentifier *string `min:"14" type:"string" required:"true"` + + // The tags to assign to the route. A tag is a label that you assign to an Amazon + // Web Services resource. Each tag consists of a key-value pair.. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateRouteInput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The configuration for the URI path route type. + UriPathRoute *UriPathRouteInput_ `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRouteInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRouteInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRouteInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRouteInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.RouteType == nil { + invalidParams.Add(request.NewErrParamRequired("RouteType")) + } + if s.ServiceIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceIdentifier")) + } + if s.ServiceIdentifier != nil && len(*s.ServiceIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ServiceIdentifier", 14)) + } + if s.UriPathRoute != nil { + if err := s.UriPathRoute.Validate(); err != nil { + invalidParams.AddNested("UriPathRoute", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *CreateRouteInput) SetApplicationIdentifier(v string) *CreateRouteInput { + s.ApplicationIdentifier = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateRouteInput) SetClientToken(v string) *CreateRouteInput { + s.ClientToken = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *CreateRouteInput) SetEnvironmentIdentifier(v string) *CreateRouteInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetRouteType sets the RouteType field's value. +func (s *CreateRouteInput) SetRouteType(v string) *CreateRouteInput { + s.RouteType = &v + return s +} + +// SetServiceIdentifier sets the ServiceIdentifier field's value. +func (s *CreateRouteInput) SetServiceIdentifier(v string) *CreateRouteInput { + s.ServiceIdentifier = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRouteInput) SetTags(v map[string]*string) *CreateRouteInput { + s.Tags = v + return s +} + +// SetUriPathRoute sets the UriPathRoute field's value. +func (s *CreateRouteInput) SetUriPathRoute(v *UriPathRouteInput_) *CreateRouteInput { + s.UriPathRoute = v + return s +} + +type CreateRouteOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application in which the route is created. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the route. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id + // . For more information about ARNs, see Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) + // in the Amazon Web Services General Reference. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the route creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the route is created. + CreatedTime *time.Time `type:"timestamp"` + + // A timestamp that indicates when the route was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The Amazon Web Services account ID of the route owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The unique identifier of the route. + RouteId *string `min:"14" type:"string"` + + // The route type of the route. + RouteType *string `type:"string" enum:"RouteType"` + + // The ID of service in which the rute iscreated. Traffic that matches this + // route is forwarded to this service. + ServiceId *string `min:"14" type:"string"` + + // he current state of the route. + State *string `type:"string" enum:"RouteState"` + + // The tags assigned to the created route. A tag is a label that you assign + // to an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateRouteOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // onfiguration for the URI path route type. + UriPathRoute *UriPathRouteInput_ `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRouteOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRouteOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *CreateRouteOutput) SetApplicationId(v string) *CreateRouteOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *CreateRouteOutput) SetArn(v string) *CreateRouteOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *CreateRouteOutput) SetCreatedByAccountId(v string) *CreateRouteOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *CreateRouteOutput) SetCreatedTime(v time.Time) *CreateRouteOutput { + s.CreatedTime = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *CreateRouteOutput) SetLastUpdatedTime(v time.Time) *CreateRouteOutput { + s.LastUpdatedTime = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *CreateRouteOutput) SetOwnerAccountId(v string) *CreateRouteOutput { + s.OwnerAccountId = &v + return s +} + +// SetRouteId sets the RouteId field's value. +func (s *CreateRouteOutput) SetRouteId(v string) *CreateRouteOutput { + s.RouteId = &v + return s +} + +// SetRouteType sets the RouteType field's value. +func (s *CreateRouteOutput) SetRouteType(v string) *CreateRouteOutput { + s.RouteType = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *CreateRouteOutput) SetServiceId(v string) *CreateRouteOutput { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateRouteOutput) SetState(v string) *CreateRouteOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRouteOutput) SetTags(v map[string]*string) *CreateRouteOutput { + s.Tags = v + return s +} + +// SetUriPathRoute sets the UriPathRoute field's value. +func (s *CreateRouteOutput) SetUriPathRoute(v *UriPathRouteInput_) *CreateRouteOutput { + s.UriPathRoute = v + return s +} + +type CreateServiceInput struct { + _ struct{} `type:"structure"` + + // The ID of the application which the service is created. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // A unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The description of the service. + Description *string `min:"1" type:"string"` + + // The type of endpoint to use for the service. The type can be a URL in a VPC + // or an Lambda function. + // + // EndpointType is a required field + EndpointType *string `type:"string" required:"true" enum:"ServiceEndpointType"` + + // The ID of the environment in which the service is created. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The configuration for the Lambda endpoint type. + LambdaEndpoint *LambdaEndpointInput_ `type:"structure"` + + // The name of the service. + // + // Name is a required field + Name *string `min:"3" type:"string" required:"true"` + + // The tags to assign to the service. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key-value pair.. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateServiceInput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The configuration for the URL endpoint type. + UrlEndpoint *UrlEndpointInput_ `type:"structure"` + + // The ID of the VPC. + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateServiceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateServiceInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.EndpointType == nil { + invalidParams.Add(request.NewErrParamRequired("EndpointType")) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Name", 3)) + } + if s.VpcId != nil && len(*s.VpcId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("VpcId", 12)) + } + if s.LambdaEndpoint != nil { + if err := s.LambdaEndpoint.Validate(); err != nil { + invalidParams.AddNested("LambdaEndpoint", err.(request.ErrInvalidParams)) + } + } + if s.UrlEndpoint != nil { + if err := s.UrlEndpoint.Validate(); err != nil { + invalidParams.AddNested("UrlEndpoint", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *CreateServiceInput) SetApplicationIdentifier(v string) *CreateServiceInput { + s.ApplicationIdentifier = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateServiceInput) SetClientToken(v string) *CreateServiceInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateServiceInput) SetDescription(v string) *CreateServiceInput { + s.Description = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *CreateServiceInput) SetEndpointType(v string) *CreateServiceInput { + s.EndpointType = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *CreateServiceInput) SetEnvironmentIdentifier(v string) *CreateServiceInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetLambdaEndpoint sets the LambdaEndpoint field's value. +func (s *CreateServiceInput) SetLambdaEndpoint(v *LambdaEndpointInput_) *CreateServiceInput { + s.LambdaEndpoint = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateServiceInput) SetName(v string) *CreateServiceInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateServiceInput) SetTags(v map[string]*string) *CreateServiceInput { + s.Tags = v + return s +} + +// SetUrlEndpoint sets the UrlEndpoint field's value. +func (s *CreateServiceInput) SetUrlEndpoint(v *UrlEndpointInput_) *CreateServiceInput { + s.UrlEndpoint = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *CreateServiceInput) SetVpcId(v string) *CreateServiceInput { + s.VpcId = &v + return s +} + +type CreateServiceOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application that the created service belongs to. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the service. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the service creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the service is created. + CreatedTime *time.Time `type:"timestamp"` + + // The description of the created service. + Description *string `min:"1" type:"string"` + + // The endpoint type of the service. + EndpointType *string `type:"string" enum:"ServiceEndpointType"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // The configuration for the Lambda endpoint type. + LambdaEndpoint *LambdaEndpointInput_ `type:"structure"` + + // A timestamp that indicates when the service was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the service. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the service owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The current state of the service. + State *string `type:"string" enum:"ServiceState"` + + // The tags assigned to the created service. A tag is a label that you assign + // to an Amazon Web Services resource. Each tag consists of a key-value pair.. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateServiceOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The configuration for the URL endpoint type. + UrlEndpoint *UrlEndpointInput_ `type:"structure"` + + // The ID of the VPC. + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *CreateServiceOutput) SetApplicationId(v string) *CreateServiceOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *CreateServiceOutput) SetArn(v string) *CreateServiceOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *CreateServiceOutput) SetCreatedByAccountId(v string) *CreateServiceOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *CreateServiceOutput) SetCreatedTime(v time.Time) *CreateServiceOutput { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateServiceOutput) SetDescription(v string) *CreateServiceOutput { + s.Description = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *CreateServiceOutput) SetEndpointType(v string) *CreateServiceOutput { + s.EndpointType = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *CreateServiceOutput) SetEnvironmentId(v string) *CreateServiceOutput { + s.EnvironmentId = &v + return s +} + +// SetLambdaEndpoint sets the LambdaEndpoint field's value. +func (s *CreateServiceOutput) SetLambdaEndpoint(v *LambdaEndpointInput_) *CreateServiceOutput { + s.LambdaEndpoint = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *CreateServiceOutput) SetLastUpdatedTime(v time.Time) *CreateServiceOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateServiceOutput) SetName(v string) *CreateServiceOutput { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *CreateServiceOutput) SetOwnerAccountId(v string) *CreateServiceOutput { + s.OwnerAccountId = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *CreateServiceOutput) SetServiceId(v string) *CreateServiceOutput { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *CreateServiceOutput) SetState(v string) *CreateServiceOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateServiceOutput) SetTags(v map[string]*string) *CreateServiceOutput { + s.Tags = v + return s +} + +// SetUrlEndpoint sets the UrlEndpoint field's value. +func (s *CreateServiceOutput) SetUrlEndpoint(v *UrlEndpointInput_) *CreateServiceOutput { + s.UrlEndpoint = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *CreateServiceOutput) SetVpcId(v string) *CreateServiceOutput { + s.VpcId = &v + return s +} + +type DeleteApplicationInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteApplicationInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *DeleteApplicationInput) SetApplicationIdentifier(v string) *DeleteApplicationInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *DeleteApplicationInput) SetEnvironmentIdentifier(v string) *DeleteApplicationInput { + s.EnvironmentIdentifier = &v + return s +} + +type DeleteApplicationOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the application. + Arn *string `min:"20" type:"string"` + + // The unique identifier of the application’s environment. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the environment was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the application. + Name *string `min:"3" type:"string"` + + // The current state of the application. + State *string `type:"string" enum:"ApplicationState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteApplicationOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *DeleteApplicationOutput) SetApplicationId(v string) *DeleteApplicationOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *DeleteApplicationOutput) SetArn(v string) *DeleteApplicationOutput { + s.Arn = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *DeleteApplicationOutput) SetEnvironmentId(v string) *DeleteApplicationOutput { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DeleteApplicationOutput) SetLastUpdatedTime(v time.Time) *DeleteApplicationOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DeleteApplicationOutput) SetName(v string) *DeleteApplicationOutput { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *DeleteApplicationOutput) SetState(v string) *DeleteApplicationOutput { + s.State = &v + return s +} + +type DeleteEnvironmentInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEnvironmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEnvironmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteEnvironmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteEnvironmentInput"} + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *DeleteEnvironmentInput) SetEnvironmentIdentifier(v string) *DeleteEnvironmentInput { + s.EnvironmentIdentifier = &v + return s +} + +type DeleteEnvironmentOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the environment. + Arn *string `min:"20" type:"string"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the environment was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the environment. + Name *string `min:"3" type:"string"` + + // The current state of the environment. + State *string `type:"string" enum:"EnvironmentState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEnvironmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteEnvironmentOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DeleteEnvironmentOutput) SetArn(v string) *DeleteEnvironmentOutput { + s.Arn = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *DeleteEnvironmentOutput) SetEnvironmentId(v string) *DeleteEnvironmentOutput { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DeleteEnvironmentOutput) SetLastUpdatedTime(v time.Time) *DeleteEnvironmentOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DeleteEnvironmentOutput) SetName(v string) *DeleteEnvironmentOutput { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *DeleteEnvironmentOutput) SetState(v string) *DeleteEnvironmentOutput { + s.State = &v + return s +} + +type DeleteResourcePolicyInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Amazon Resource Name (ARN) of the resource associated with the policy. + // + // Identifier is a required field + Identifier *string `location:"uri" locationName:"Identifier" min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResourcePolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResourcePolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteResourcePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteResourcePolicyInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 20 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *DeleteResourcePolicyInput) SetIdentifier(v string) *DeleteResourcePolicyInput { + s.Identifier = &v + return s +} + +type DeleteResourcePolicyOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResourcePolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteResourcePolicyOutput) GoString() string { + return s.String() +} + +type DeleteRouteInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application to delete the route from. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment to delete the route from. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the route to delete. + // + // RouteIdentifier is a required field + RouteIdentifier *string `location:"uri" locationName:"RouteIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRouteInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRouteInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRouteInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRouteInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.RouteIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("RouteIdentifier")) + } + if s.RouteIdentifier != nil && len(*s.RouteIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("RouteIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *DeleteRouteInput) SetApplicationIdentifier(v string) *DeleteRouteInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *DeleteRouteInput) SetEnvironmentIdentifier(v string) *DeleteRouteInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetRouteIdentifier sets the RouteIdentifier field's value. +func (s *DeleteRouteInput) SetRouteIdentifier(v string) *DeleteRouteInput { + s.RouteIdentifier = &v + return s +} + +type DeleteRouteOutput struct { + _ struct{} `type:"structure"` + + // he ID of the application that the route belongs to. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the route. + Arn *string `min:"20" type:"string"` + + // A timestamp that indicates when the route was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The ID of the route to delete. + RouteId *string `min:"14" type:"string"` + + // The ID of the service that the route belongs to. + ServiceId *string `min:"14" type:"string"` + + // The current state of the route. + State *string `type:"string" enum:"RouteState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRouteOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRouteOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *DeleteRouteOutput) SetApplicationId(v string) *DeleteRouteOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *DeleteRouteOutput) SetArn(v string) *DeleteRouteOutput { + s.Arn = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DeleteRouteOutput) SetLastUpdatedTime(v time.Time) *DeleteRouteOutput { + s.LastUpdatedTime = &v + return s +} + +// SetRouteId sets the RouteId field's value. +func (s *DeleteRouteOutput) SetRouteId(v string) *DeleteRouteOutput { + s.RouteId = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *DeleteRouteOutput) SetServiceId(v string) *DeleteRouteOutput { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *DeleteRouteOutput) SetState(v string) *DeleteRouteOutput { + s.State = &v + return s +} + +type DeleteServiceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Deletes a Refactor Spaces service. + // + // The RefactorSpacesSecurityGroup security group must be removed from all Amazon + // Web Services resources in the virtual private cloud (VPC) prior to deleting + // a service with a URL endpoint in a VPC. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment that the service is in. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the service to delete. + // + // ServiceIdentifier is a required field + ServiceIdentifier *string `location:"uri" locationName:"ServiceIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteServiceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteServiceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteServiceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteServiceInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.ServiceIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceIdentifier")) + } + if s.ServiceIdentifier != nil && len(*s.ServiceIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ServiceIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *DeleteServiceInput) SetApplicationIdentifier(v string) *DeleteServiceInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *DeleteServiceInput) SetEnvironmentIdentifier(v string) *DeleteServiceInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetServiceIdentifier sets the ServiceIdentifier field's value. +func (s *DeleteServiceInput) SetServiceIdentifier(v string) *DeleteServiceInput { + s.ServiceIdentifier = &v + return s +} + +type DeleteServiceOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application that the service is in. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the service. + Arn *string `min:"20" type:"string"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the service was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the service. + Name *string `min:"3" type:"string"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The current state of the service. + State *string `type:"string" enum:"ServiceState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteServiceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteServiceOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *DeleteServiceOutput) SetApplicationId(v string) *DeleteServiceOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *DeleteServiceOutput) SetArn(v string) *DeleteServiceOutput { + s.Arn = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *DeleteServiceOutput) SetEnvironmentId(v string) *DeleteServiceOutput { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *DeleteServiceOutput) SetLastUpdatedTime(v time.Time) *DeleteServiceOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DeleteServiceOutput) SetName(v string) *DeleteServiceOutput { + s.Name = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *DeleteServiceOutput) SetServiceId(v string) *DeleteServiceOutput { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *DeleteServiceOutput) SetState(v string) *DeleteServiceOutput { + s.State = &v + return s +} + +// The summary information for environments as a response to ListEnvironments. +type EnvironmentSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the environment. + Arn *string `min:"20" type:"string"` + + // A timestamp that indicates when the environment is created. + CreatedTime *time.Time `type:"timestamp"` + + // A description of the environment. + Description *string `min:"1" type:"string"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the environment resource. + Error *ErrorResponse `type:"structure"` + + // A timestamp that indicates when the environment was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the environment. + Name *string `min:"3" type:"string"` + + // The network fabric type of the environment. + NetworkFabricType *string `type:"string" enum:"NetworkFabricType"` + + // The Amazon Web Services account ID of the environment owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The current state of the environment. + State *string `type:"string" enum:"EnvironmentState"` + + // The tags assigned to the environment. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by EnvironmentSummary's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the transit gateway set up by the environment. + TransitGatewayId *string `min:"21" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnvironmentSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnvironmentSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *EnvironmentSummary) SetArn(v string) *EnvironmentSummary { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *EnvironmentSummary) SetCreatedTime(v time.Time) *EnvironmentSummary { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *EnvironmentSummary) SetDescription(v string) *EnvironmentSummary { + s.Description = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *EnvironmentSummary) SetEnvironmentId(v string) *EnvironmentSummary { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *EnvironmentSummary) SetError(v *ErrorResponse) *EnvironmentSummary { + s.Error = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *EnvironmentSummary) SetLastUpdatedTime(v time.Time) *EnvironmentSummary { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *EnvironmentSummary) SetName(v string) *EnvironmentSummary { + s.Name = &v + return s +} + +// SetNetworkFabricType sets the NetworkFabricType field's value. +func (s *EnvironmentSummary) SetNetworkFabricType(v string) *EnvironmentSummary { + s.NetworkFabricType = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *EnvironmentSummary) SetOwnerAccountId(v string) *EnvironmentSummary { + s.OwnerAccountId = &v + return s +} + +// SetState sets the State field's value. +func (s *EnvironmentSummary) SetState(v string) *EnvironmentSummary { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *EnvironmentSummary) SetTags(v map[string]*string) *EnvironmentSummary { + s.Tags = v + return s +} + +// SetTransitGatewayId sets the TransitGatewayId field's value. +func (s *EnvironmentSummary) SetTransitGatewayId(v string) *EnvironmentSummary { + s.TransitGatewayId = &v + return s +} + +// Provides summary information for the EnvironmentVpc resource as a response +// to ListEnvironmentVpc. +type EnvironmentVpc struct { + _ struct{} `type:"structure"` + + // The Amazon Web Services account ID of the virtual private cloud (VPC) owner. + AccountId *string `min:"12" type:"string"` + + // The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks. + CidrBlocks []*string `min:"1" type:"list"` + + // A timestamp that indicates when the VPC is first added to the environment. + CreatedTime *time.Time `type:"timestamp"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // A timestamp that indicates when the VPC was last updated by the environment. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The ID of the VPC. + VpcId *string `min:"12" type:"string"` + + // The name of the VPC at the time it is added to the environment. + VpcName *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnvironmentVpc) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnvironmentVpc) GoString() string { + return s.String() +} + +// SetAccountId sets the AccountId field's value. +func (s *EnvironmentVpc) SetAccountId(v string) *EnvironmentVpc { + s.AccountId = &v + return s +} + +// SetCidrBlocks sets the CidrBlocks field's value. +func (s *EnvironmentVpc) SetCidrBlocks(v []*string) *EnvironmentVpc { + s.CidrBlocks = v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *EnvironmentVpc) SetCreatedTime(v time.Time) *EnvironmentVpc { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *EnvironmentVpc) SetEnvironmentId(v string) *EnvironmentVpc { + s.EnvironmentId = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *EnvironmentVpc) SetLastUpdatedTime(v time.Time) *EnvironmentVpc { + s.LastUpdatedTime = &v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *EnvironmentVpc) SetVpcId(v string) *EnvironmentVpc { + s.VpcId = &v + return s +} + +// SetVpcName sets the VpcName field's value. +func (s *EnvironmentVpc) SetVpcName(v string) *EnvironmentVpc { + s.VpcName = &v + return s +} + +// Error associated with a resource returned for a Get or List resource response. +type ErrorResponse struct { + _ struct{} `type:"structure"` + + // The Amazon Web Services account ID of the resource owner. + AccountId *string `min:"12" type:"string"` + + // Additional details about the error. + AdditionalDetails map[string]*string `type:"map"` + + // The error code associated with the error. + Code *string `type:"string" enum:"ErrorCode"` + + // The message associated with the error. + Message *string `type:"string"` + + // The ID of the resource. + ResourceIdentifier *string `min:"3" type:"string"` + + // The type of resource. + ResourceType *string `type:"string" enum:"ErrorResourceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorResponse) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorResponse) GoString() string { + return s.String() +} + +// SetAccountId sets the AccountId field's value. +func (s *ErrorResponse) SetAccountId(v string) *ErrorResponse { + s.AccountId = &v + return s +} + +// SetAdditionalDetails sets the AdditionalDetails field's value. +func (s *ErrorResponse) SetAdditionalDetails(v map[string]*string) *ErrorResponse { + s.AdditionalDetails = v + return s +} + +// SetCode sets the Code field's value. +func (s *ErrorResponse) SetCode(v string) *ErrorResponse { + s.Code = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *ErrorResponse) SetMessage(v string) *ErrorResponse { + s.Message = &v + return s +} + +// SetResourceIdentifier sets the ResourceIdentifier field's value. +func (s *ErrorResponse) SetResourceIdentifier(v string) *ErrorResponse { + s.ResourceIdentifier = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *ErrorResponse) SetResourceType(v string) *ErrorResponse { + s.ResourceType = &v + return s +} + +type GetApplicationInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetApplicationInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *GetApplicationInput) SetApplicationIdentifier(v string) *GetApplicationInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *GetApplicationInput) SetEnvironmentIdentifier(v string) *GetApplicationInput { + s.EnvironmentIdentifier = &v + return s +} + +type GetApplicationOutput struct { + _ struct{} `type:"structure"` + + // The endpoint URL of the API Gateway proxy. + ApiGatewayProxy *ApiGatewayProxyConfig `type:"structure"` + + // The unique identifier of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the application. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the application creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the application is created. + CreatedTime *time.Time `type:"timestamp"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the application resource. + Error *ErrorResponse `type:"structure"` + + // A timestamp that indicates when the application was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the application. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the application owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The proxy type of the proxy created within the application. + ProxyType *string `type:"string" enum:"ProxyType"` + + // The current state of the application. + State *string `type:"string" enum:"ApplicationState"` + + // The tags assigned to the application. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetApplicationOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the virtual private cloud (VPC). + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetApplicationOutput) GoString() string { + return s.String() +} + +// SetApiGatewayProxy sets the ApiGatewayProxy field's value. +func (s *GetApplicationOutput) SetApiGatewayProxy(v *ApiGatewayProxyConfig) *GetApplicationOutput { + s.ApiGatewayProxy = v + return s +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *GetApplicationOutput) SetApplicationId(v string) *GetApplicationOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *GetApplicationOutput) SetArn(v string) *GetApplicationOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *GetApplicationOutput) SetCreatedByAccountId(v string) *GetApplicationOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *GetApplicationOutput) SetCreatedTime(v time.Time) *GetApplicationOutput { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *GetApplicationOutput) SetEnvironmentId(v string) *GetApplicationOutput { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *GetApplicationOutput) SetError(v *ErrorResponse) *GetApplicationOutput { + s.Error = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *GetApplicationOutput) SetLastUpdatedTime(v time.Time) *GetApplicationOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetApplicationOutput) SetName(v string) *GetApplicationOutput { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *GetApplicationOutput) SetOwnerAccountId(v string) *GetApplicationOutput { + s.OwnerAccountId = &v + return s +} + +// SetProxyType sets the ProxyType field's value. +func (s *GetApplicationOutput) SetProxyType(v string) *GetApplicationOutput { + s.ProxyType = &v + return s +} + +// SetState sets the State field's value. +func (s *GetApplicationOutput) SetState(v string) *GetApplicationOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetApplicationOutput) SetTags(v map[string]*string) *GetApplicationOutput { + s.Tags = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *GetApplicationOutput) SetVpcId(v string) *GetApplicationOutput { + s.VpcId = &v + return s +} + +type GetEnvironmentInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEnvironmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEnvironmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEnvironmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEnvironmentInput"} + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *GetEnvironmentInput) SetEnvironmentIdentifier(v string) *GetEnvironmentInput { + s.EnvironmentIdentifier = &v + return s +} + +type GetEnvironmentOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the environment. + Arn *string `min:"20" type:"string"` + + // A timestamp that indicates when the environment is created. + CreatedTime *time.Time `type:"timestamp"` + + // The description of the environment. + Description *string `min:"1" type:"string"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the environment resource. + Error *ErrorResponse `type:"structure"` + + // A timestamp that indicates when the environment was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the environment. + Name *string `min:"3" type:"string"` + + // The network fabric type of the environment. + NetworkFabricType *string `type:"string" enum:"NetworkFabricType"` + + // The Amazon Web Services account ID of the environment owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The current state of the environment. + State *string `type:"string" enum:"EnvironmentState"` + + // The tags to assign to the environment. A tag is a label that you assign to + // an Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetEnvironmentOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The ID of the transit gateway set up by the environment. + TransitGatewayId *string `min:"21" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEnvironmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEnvironmentOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *GetEnvironmentOutput) SetArn(v string) *GetEnvironmentOutput { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *GetEnvironmentOutput) SetCreatedTime(v time.Time) *GetEnvironmentOutput { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *GetEnvironmentOutput) SetDescription(v string) *GetEnvironmentOutput { + s.Description = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *GetEnvironmentOutput) SetEnvironmentId(v string) *GetEnvironmentOutput { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *GetEnvironmentOutput) SetError(v *ErrorResponse) *GetEnvironmentOutput { + s.Error = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *GetEnvironmentOutput) SetLastUpdatedTime(v time.Time) *GetEnvironmentOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetEnvironmentOutput) SetName(v string) *GetEnvironmentOutput { + s.Name = &v + return s +} + +// SetNetworkFabricType sets the NetworkFabricType field's value. +func (s *GetEnvironmentOutput) SetNetworkFabricType(v string) *GetEnvironmentOutput { + s.NetworkFabricType = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *GetEnvironmentOutput) SetOwnerAccountId(v string) *GetEnvironmentOutput { + s.OwnerAccountId = &v + return s +} + +// SetState sets the State field's value. +func (s *GetEnvironmentOutput) SetState(v string) *GetEnvironmentOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetEnvironmentOutput) SetTags(v map[string]*string) *GetEnvironmentOutput { + s.Tags = v + return s +} + +// SetTransitGatewayId sets the TransitGatewayId field's value. +func (s *GetEnvironmentOutput) SetTransitGatewayId(v string) *GetEnvironmentOutput { + s.TransitGatewayId = &v + return s +} + +type GetResourcePolicyInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the resource associated with the policy. + // + // Identifier is a required field + Identifier *string `location:"uri" locationName:"Identifier" min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetResourcePolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetResourcePolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetResourcePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetResourcePolicyInput"} + if s.Identifier == nil { + invalidParams.Add(request.NewErrParamRequired("Identifier")) + } + if s.Identifier != nil && len(*s.Identifier) < 20 { + invalidParams.Add(request.NewErrParamMinLen("Identifier", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetIdentifier sets the Identifier field's value. +func (s *GetResourcePolicyInput) SetIdentifier(v string) *GetResourcePolicyInput { + s.Identifier = &v + return s +} + +type GetResourcePolicyOutput struct { + _ struct{} `type:"structure"` + + // A JSON-formatted string for an Amazon Web Services resource-based policy. + Policy *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetResourcePolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetResourcePolicyOutput) GoString() string { + return s.String() +} + +// SetPolicy sets the Policy field's value. +func (s *GetResourcePolicyOutput) SetPolicy(v string) *GetResourcePolicyOutput { + s.Policy = &v + return s +} + +type GetRouteInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the route. + // + // RouteIdentifier is a required field + RouteIdentifier *string `location:"uri" locationName:"RouteIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRouteInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRouteInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetRouteInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetRouteInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.RouteIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("RouteIdentifier")) + } + if s.RouteIdentifier != nil && len(*s.RouteIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("RouteIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *GetRouteInput) SetApplicationIdentifier(v string) *GetRouteInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *GetRouteInput) SetEnvironmentIdentifier(v string) *GetRouteInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetRouteIdentifier sets the RouteIdentifier field's value. +func (s *GetRouteInput) SetRouteIdentifier(v string) *GetRouteInput { + s.RouteIdentifier = &v + return s +} + +type GetRouteOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application that the route belongs to. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the route. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the route creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // The timestamp of when the route is created. + CreatedTime *time.Time `type:"timestamp"` + + // Unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the route resource. + Error *ErrorResponse `type:"structure"` + + // Indicates whether to match all subpaths of the given source path. If this + // value is false, requests must match the source path exactly before they are + // forwarded to this route's service. + IncludeChildPaths *bool `type:"boolean"` + + // A timestamp that indicates when the route was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // A list of HTTP methods to match. An empty list matches all values. If a method + // is present, only HTTP requests using that method are forwarded to this route’s + // service. + Methods []*string `type:"list"` + + // The Amazon Web Services account ID of the route owner. + OwnerAccountId *string `min:"12" type:"string"` + + // A mapping of Amazon API Gateway path resources to resource IDs. + PathResourceToId map[string]*string `type:"map"` + + // The unique identifier of the route. + // + // DEFAULT: All traffic that does not match another route is forwarded to the + // default route. Applications must have a default route before any other routes + // can be created. + // + // URI_PATH: A route that is based on a URI path. + RouteId *string `min:"14" type:"string"` + + // The type of route. + RouteType *string `type:"string" enum:"RouteType"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The path to use to match traffic. Paths must start with / and are relative + // to the base of the application. + SourcePath *string `min:"1" type:"string"` + + // The current state of the route. + State *string `type:"string" enum:"RouteState"` + + // The tags assigned to the route. A tag is a label that you assign to an Amazon + // Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetRouteOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRouteOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetRouteOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *GetRouteOutput) SetApplicationId(v string) *GetRouteOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *GetRouteOutput) SetArn(v string) *GetRouteOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *GetRouteOutput) SetCreatedByAccountId(v string) *GetRouteOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *GetRouteOutput) SetCreatedTime(v time.Time) *GetRouteOutput { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *GetRouteOutput) SetEnvironmentId(v string) *GetRouteOutput { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *GetRouteOutput) SetError(v *ErrorResponse) *GetRouteOutput { + s.Error = v + return s +} + +// SetIncludeChildPaths sets the IncludeChildPaths field's value. +func (s *GetRouteOutput) SetIncludeChildPaths(v bool) *GetRouteOutput { + s.IncludeChildPaths = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *GetRouteOutput) SetLastUpdatedTime(v time.Time) *GetRouteOutput { + s.LastUpdatedTime = &v + return s +} + +// SetMethods sets the Methods field's value. +func (s *GetRouteOutput) SetMethods(v []*string) *GetRouteOutput { + s.Methods = v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *GetRouteOutput) SetOwnerAccountId(v string) *GetRouteOutput { + s.OwnerAccountId = &v + return s +} + +// SetPathResourceToId sets the PathResourceToId field's value. +func (s *GetRouteOutput) SetPathResourceToId(v map[string]*string) *GetRouteOutput { + s.PathResourceToId = v + return s +} + +// SetRouteId sets the RouteId field's value. +func (s *GetRouteOutput) SetRouteId(v string) *GetRouteOutput { + s.RouteId = &v + return s +} + +// SetRouteType sets the RouteType field's value. +func (s *GetRouteOutput) SetRouteType(v string) *GetRouteOutput { + s.RouteType = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *GetRouteOutput) SetServiceId(v string) *GetRouteOutput { + s.ServiceId = &v + return s +} + +// SetSourcePath sets the SourcePath field's value. +func (s *GetRouteOutput) SetSourcePath(v string) *GetRouteOutput { + s.SourcePath = &v + return s +} + +// SetState sets the State field's value. +func (s *GetRouteOutput) SetState(v string) *GetRouteOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetRouteOutput) SetTags(v map[string]*string) *GetRouteOutput { + s.Tags = v + return s +} + +type GetServiceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the service. + // + // ServiceIdentifier is a required field + ServiceIdentifier *string `location:"uri" locationName:"ServiceIdentifier" min:"14" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServiceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServiceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetServiceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetServiceInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.ServiceIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ServiceIdentifier")) + } + if s.ServiceIdentifier != nil && len(*s.ServiceIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ServiceIdentifier", 14)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *GetServiceInput) SetApplicationIdentifier(v string) *GetServiceInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *GetServiceInput) SetEnvironmentIdentifier(v string) *GetServiceInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetServiceIdentifier sets the ServiceIdentifier field's value. +func (s *GetServiceInput) SetServiceIdentifier(v string) *GetServiceInput { + s.ServiceIdentifier = &v + return s +} + +type GetServiceOutput struct { + _ struct{} `type:"structure"` + + // The ID of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the service. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the service creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // The timestamp of when the service is created. + CreatedTime *time.Time `type:"timestamp"` + + // The description of the service. + Description *string `min:"1" type:"string"` + + // The endpoint type of the service. + EndpointType *string `type:"string" enum:"ServiceEndpointType"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the service resource. + Error *ErrorResponse `type:"structure"` + + // The configuration for the Lambda endpoint type. + // + // The Arn is the Amazon Resource Name (ARN) of the Lambda function associated + // with this service. + LambdaEndpoint *LambdaEndpointConfig `type:"structure"` + + // A timestamp that indicates when the service was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the service. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the service owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The current state of the service. + State *string `type:"string" enum:"ServiceState"` + + // The tags assigned to the service. A tag is a label that you assign to an + // Amazon Web Services resource. Each tag consists of a key-value pair. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetServiceOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The configuration for the URL endpoint type. + // + // The Url isthe URL of the endpoint type. + // + // The HealthUrl is the health check URL of the endpoint type. + UrlEndpoint *UrlEndpointConfig `type:"structure"` + + // The ID of the virtual private cloud (VPC). + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServiceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServiceOutput) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *GetServiceOutput) SetApplicationId(v string) *GetServiceOutput { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *GetServiceOutput) SetArn(v string) *GetServiceOutput { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *GetServiceOutput) SetCreatedByAccountId(v string) *GetServiceOutput { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *GetServiceOutput) SetCreatedTime(v time.Time) *GetServiceOutput { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *GetServiceOutput) SetDescription(v string) *GetServiceOutput { + s.Description = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *GetServiceOutput) SetEndpointType(v string) *GetServiceOutput { + s.EndpointType = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *GetServiceOutput) SetEnvironmentId(v string) *GetServiceOutput { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *GetServiceOutput) SetError(v *ErrorResponse) *GetServiceOutput { + s.Error = v + return s +} + +// SetLambdaEndpoint sets the LambdaEndpoint field's value. +func (s *GetServiceOutput) SetLambdaEndpoint(v *LambdaEndpointConfig) *GetServiceOutput { + s.LambdaEndpoint = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *GetServiceOutput) SetLastUpdatedTime(v time.Time) *GetServiceOutput { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetServiceOutput) SetName(v string) *GetServiceOutput { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *GetServiceOutput) SetOwnerAccountId(v string) *GetServiceOutput { + s.OwnerAccountId = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *GetServiceOutput) SetServiceId(v string) *GetServiceOutput { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *GetServiceOutput) SetState(v string) *GetServiceOutput { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *GetServiceOutput) SetTags(v map[string]*string) *GetServiceOutput { + s.Tags = v + return s +} + +// SetUrlEndpoint sets the UrlEndpoint field's value. +func (s *GetServiceOutput) SetUrlEndpoint(v *UrlEndpointConfig) *GetServiceOutput { + s.UrlEndpoint = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *GetServiceOutput) SetVpcId(v string) *GetServiceOutput { + s.VpcId = &v + return s +} + +// An unexpected error occurred while processing the request. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The resource policy is not valid. +type InvalidResourcePolicyException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidResourcePolicyException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidResourcePolicyException) GoString() string { + return s.String() +} + +func newErrorInvalidResourcePolicyException(v protocol.ResponseMetadata) error { + return &InvalidResourcePolicyException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InvalidResourcePolicyException) Code() string { + return "InvalidResourcePolicyException" +} + +// Message returns the exception's message. +func (s *InvalidResourcePolicyException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidResourcePolicyException) OrigErr() error { + return nil +} + +func (s *InvalidResourcePolicyException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InvalidResourcePolicyException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InvalidResourcePolicyException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The configuration for the Lambda endpoint type. +type LambdaEndpointConfig struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Lambda endpoint. + Arn *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointConfig) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *LambdaEndpointConfig) SetArn(v string) *LambdaEndpointConfig { + s.Arn = &v + return s +} + +// The input for the Lambda endpoint type. +type LambdaEndpointInput_ struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Lambda endpoint. + // + // Arn is a required field + Arn *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LambdaEndpointInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LambdaEndpointInput_"} + if s.Arn == nil { + invalidParams.Add(request.NewErrParamRequired("Arn")) + } + if s.Arn != nil && len(*s.Arn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Arn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArn sets the Arn field's value. +func (s *LambdaEndpointInput_) SetArn(v string) *LambdaEndpointInput_ { + s.Arn = &v + return s +} + +// The summary for the Lambda endpoint type. +type LambdaEndpointSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Lambda endpoint. + Arn *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LambdaEndpointSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *LambdaEndpointSummary) SetArn(v string) *LambdaEndpointSummary { + s.Arn = &v + return s +} + +type ListApplicationsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListApplicationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListApplicationsInput"} + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *ListApplicationsInput) SetEnvironmentIdentifier(v string) *ListApplicationsInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListApplicationsInput) SetMaxResults(v int64) *ListApplicationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationsInput) SetNextToken(v string) *ListApplicationsInput { + s.NextToken = &v + return s +} + +type ListApplicationsOutput struct { + _ struct{} `type:"structure"` + + // The list of ApplicationSummary objects. + ApplicationSummaryList []*ApplicationSummary `type:"list"` + + // The token for the next page of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationsOutput) GoString() string { + return s.String() +} + +// SetApplicationSummaryList sets the ApplicationSummaryList field's value. +func (s *ListApplicationsOutput) SetApplicationSummaryList(v []*ApplicationSummary) *ListApplicationsOutput { + s.ApplicationSummaryList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationsOutput) SetNextToken(v string) *ListApplicationsOutput { + s.NextToken = &v + return s +} + +type ListEnvironmentVpcsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentVpcsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentVpcsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEnvironmentVpcsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEnvironmentVpcsInput"} + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *ListEnvironmentVpcsInput) SetEnvironmentIdentifier(v string) *ListEnvironmentVpcsInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEnvironmentVpcsInput) SetMaxResults(v int64) *ListEnvironmentVpcsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEnvironmentVpcsInput) SetNextToken(v string) *ListEnvironmentVpcsInput { + s.NextToken = &v + return s +} + +type ListEnvironmentVpcsOutput struct { + _ struct{} `type:"structure"` + + // The list of EnvironmentVpc objects. + EnvironmentVpcList []*EnvironmentVpc `type:"list"` + + // The token for the next page of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentVpcsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentVpcsOutput) GoString() string { + return s.String() +} + +// SetEnvironmentVpcList sets the EnvironmentVpcList field's value. +func (s *ListEnvironmentVpcsOutput) SetEnvironmentVpcList(v []*EnvironmentVpc) *ListEnvironmentVpcsOutput { + s.EnvironmentVpcList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEnvironmentVpcsOutput) SetNextToken(v string) *ListEnvironmentVpcsOutput { + s.NextToken = &v + return s +} + +type ListEnvironmentsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEnvironmentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEnvironmentsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEnvironmentsInput) SetMaxResults(v int64) *ListEnvironmentsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEnvironmentsInput) SetNextToken(v string) *ListEnvironmentsInput { + s.NextToken = &v + return s +} + +type ListEnvironmentsOutput struct { + _ struct{} `type:"structure"` + + // The list of EnvironmentSummary objects. + EnvironmentSummaryList []*EnvironmentSummary `type:"list"` + + // The token for the next page of results. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEnvironmentsOutput) GoString() string { + return s.String() +} + +// SetEnvironmentSummaryList sets the EnvironmentSummaryList field's value. +func (s *ListEnvironmentsOutput) SetEnvironmentSummaryList(v []*EnvironmentSummary) *ListEnvironmentsOutput { + s.EnvironmentSummaryList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEnvironmentsOutput) SetNextToken(v string) *ListEnvironmentsOutput { + s.NextToken = &v + return s +} + +type ListRoutesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRoutesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRoutesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRoutesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRoutesInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *ListRoutesInput) SetApplicationIdentifier(v string) *ListRoutesInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *ListRoutesInput) SetEnvironmentIdentifier(v string) *ListRoutesInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRoutesInput) SetMaxResults(v int64) *ListRoutesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRoutesInput) SetNextToken(v string) *ListRoutesInput { + s.NextToken = &v + return s +} + +type ListRoutesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next page of results. + NextToken *string `min:"1" type:"string"` + + // The list of RouteSummary objects. + RouteSummaryList []*RouteSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRoutesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRoutesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRoutesOutput) SetNextToken(v string) *ListRoutesOutput { + s.NextToken = &v + return s +} + +// SetRouteSummaryList sets the RouteSummaryList field's value. +func (s *ListRoutesOutput) SetRouteSummaryList(v []*RouteSummary) *ListRoutesOutput { + s.RouteSummaryList = v + return s +} + +type ListServicesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the application. + // + // ApplicationIdentifier is a required field + ApplicationIdentifier *string `location:"uri" locationName:"ApplicationIdentifier" min:"14" type:"string" required:"true"` + + // The ID of the environment. + // + // EnvironmentIdentifier is a required field + EnvironmentIdentifier *string `location:"uri" locationName:"EnvironmentIdentifier" min:"14" type:"string" required:"true"` + + // The maximum number of results to return with a single call. To retrieve the + // remaining results, make another call with the returned nextToken value. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListServicesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListServicesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListServicesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListServicesInput"} + if s.ApplicationIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationIdentifier")) + } + if s.ApplicationIdentifier != nil && len(*s.ApplicationIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationIdentifier", 14)) + } + if s.EnvironmentIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentIdentifier")) + } + if s.EnvironmentIdentifier != nil && len(*s.EnvironmentIdentifier) < 14 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentIdentifier", 14)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationIdentifier sets the ApplicationIdentifier field's value. +func (s *ListServicesInput) SetApplicationIdentifier(v string) *ListServicesInput { + s.ApplicationIdentifier = &v + return s +} + +// SetEnvironmentIdentifier sets the EnvironmentIdentifier field's value. +func (s *ListServicesInput) SetEnvironmentIdentifier(v string) *ListServicesInput { + s.EnvironmentIdentifier = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListServicesInput) SetMaxResults(v int64) *ListServicesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListServicesInput) SetNextToken(v string) *ListServicesInput { + s.NextToken = &v + return s +} + +type ListServicesOutput struct { + _ struct{} `type:"structure"` + + // The token for the next page of results. + NextToken *string `min:"1" type:"string"` + + // The list of ServiceSummary objects. + ServiceSummaryList []*ServiceSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListServicesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListServicesOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListServicesOutput) SetNextToken(v string) *ListServicesOutput { + s.NextToken = &v + return s +} + +// SetServiceSummaryList sets the ServiceSummaryList field's value. +func (s *ListServicesOutput) SetServiceSummaryList(v []*ServiceSummary) *ListServicesOutput { + s.ServiceSummaryList = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The list of tags assigned to the resource. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ListTagsForResourceOutput's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +type PutResourcePolicyInput struct { + _ struct{} `type:"structure"` + + // A JSON-formatted string for an Amazon Web Services resource-based policy. + // + // Policy is a required field + Policy *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the resource to which the policy is being + // attached. + // + // ResourceArn is a required field + ResourceArn *string `min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutResourcePolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutResourcePolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutResourcePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutResourcePolicyInput"} + if s.Policy == nil { + invalidParams.Add(request.NewErrParamRequired("Policy")) + } + if s.Policy != nil && len(*s.Policy) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Policy", 1)) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPolicy sets the Policy field's value. +func (s *PutResourcePolicyInput) SetPolicy(v string) *PutResourcePolicyInput { + s.Policy = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *PutResourcePolicyInput) SetResourceArn(v string) *PutResourcePolicyInput { + s.ResourceArn = &v + return s +} + +type PutResourcePolicyOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutResourcePolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PutResourcePolicyOutput) GoString() string { + return s.String() +} + +// The request references a resource that does not exist. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The ID of the resource. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The type of resource. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The summary information for the routes as a response to ListRoutes. +type RouteSummary struct { + _ struct{} `type:"structure"` + + // The unique identifier of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the route. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the route creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the route is created. + CreatedTime *time.Time `type:"timestamp"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the route resource. + Error *ErrorResponse `type:"structure"` + + // Indicates whether to match all subpaths of the given source path. If this + // value is false, requests must match the source path exactly before they are + // forwarded to this route's service. + IncludeChildPaths *bool `type:"boolean"` + + // A timestamp that indicates when the route was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // A list of HTTP methods to match. An empty list matches all values. If a method + // is present, only HTTP requests using that method are forwarded to this route’s + // service. + Methods []*string `type:"list"` + + // The Amazon Web Services account ID of the route owner. + OwnerAccountId *string `min:"12" type:"string"` + + // A mapping of Amazon API Gateway path resources to resource IDs. + PathResourceToId map[string]*string `type:"map"` + + // The unique identifier of the route. + RouteId *string `min:"14" type:"string"` + + // The route type of the route. + RouteType *string `type:"string" enum:"RouteType"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The path to use to match traffic. Paths must start with / and are relative + // to the base of the application. + SourcePath *string `min:"1" type:"string"` + + // The current state of the route. + State *string `type:"string" enum:"RouteState"` + + // The tags assigned to the route. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by RouteSummary's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RouteSummary) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *RouteSummary) SetApplicationId(v string) *RouteSummary { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *RouteSummary) SetArn(v string) *RouteSummary { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *RouteSummary) SetCreatedByAccountId(v string) *RouteSummary { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *RouteSummary) SetCreatedTime(v time.Time) *RouteSummary { + s.CreatedTime = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *RouteSummary) SetEnvironmentId(v string) *RouteSummary { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *RouteSummary) SetError(v *ErrorResponse) *RouteSummary { + s.Error = v + return s +} + +// SetIncludeChildPaths sets the IncludeChildPaths field's value. +func (s *RouteSummary) SetIncludeChildPaths(v bool) *RouteSummary { + s.IncludeChildPaths = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *RouteSummary) SetLastUpdatedTime(v time.Time) *RouteSummary { + s.LastUpdatedTime = &v + return s +} + +// SetMethods sets the Methods field's value. +func (s *RouteSummary) SetMethods(v []*string) *RouteSummary { + s.Methods = v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *RouteSummary) SetOwnerAccountId(v string) *RouteSummary { + s.OwnerAccountId = &v + return s +} + +// SetPathResourceToId sets the PathResourceToId field's value. +func (s *RouteSummary) SetPathResourceToId(v map[string]*string) *RouteSummary { + s.PathResourceToId = v + return s +} + +// SetRouteId sets the RouteId field's value. +func (s *RouteSummary) SetRouteId(v string) *RouteSummary { + s.RouteId = &v + return s +} + +// SetRouteType sets the RouteType field's value. +func (s *RouteSummary) SetRouteType(v string) *RouteSummary { + s.RouteType = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *RouteSummary) SetServiceId(v string) *RouteSummary { + s.ServiceId = &v + return s +} + +// SetSourcePath sets the SourcePath field's value. +func (s *RouteSummary) SetSourcePath(v string) *RouteSummary { + s.SourcePath = &v + return s +} + +// SetState sets the State field's value. +func (s *RouteSummary) SetState(v string) *RouteSummary { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *RouteSummary) SetTags(v map[string]*string) *RouteSummary { + s.Tags = v + return s +} + +// The request would cause a service quota to be exceeded. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // Service quota requirement to identify originating quota. Reached throttling + // quota exception. + QuotaCode *string `type:"string"` + + // The ID of the resource. + // + // ResourceId is a required field + ResourceId *string `type:"string" required:"true"` + + // The type of resource. + // + // ResourceType is a required field + ResourceType *string `type:"string" required:"true"` + + // Service quota requirement to identify originating service. Reached throttling + // quota exception service code. + // + // ServiceCode is a required field + ServiceCode *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A summary for the service as a response to ListServices. +type ServiceSummary struct { + _ struct{} `type:"structure"` + + // The unique identifier of the application. + ApplicationId *string `min:"14" type:"string"` + + // The Amazon Resource Name (ARN) of the service. + Arn *string `min:"20" type:"string"` + + // The Amazon Web Services account ID of the service creator. + CreatedByAccountId *string `min:"12" type:"string"` + + // A timestamp that indicates when the service is created. + CreatedTime *time.Time `type:"timestamp"` + + // A description of the service. + Description *string `min:"1" type:"string"` + + // The endpoint type of the service. + EndpointType *string `type:"string" enum:"ServiceEndpointType"` + + // The unique identifier of the environment. + EnvironmentId *string `min:"14" type:"string"` + + // Any error associated with the service resource. + Error *ErrorResponse `type:"structure"` + + // A summary of the configuration for the Lambda endpoint type. + LambdaEndpoint *LambdaEndpointSummary `type:"structure"` + + // A timestamp that indicates when the service was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the service. + Name *string `min:"3" type:"string"` + + // The Amazon Web Services account ID of the service owner. + OwnerAccountId *string `min:"12" type:"string"` + + // The unique identifier of the service. + ServiceId *string `min:"14" type:"string"` + + // The current state of the service. + State *string `type:"string" enum:"ServiceState"` + + // The tags assigned to the service. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ServiceSummary's + // String and GoString methods. + Tags map[string]*string `type:"map" sensitive:"true"` + + // The summary of the configuration for the URL endpoint type. + UrlEndpoint *UrlEndpointSummary `type:"structure"` + + // The ID of the virtual private cloud (VPC). + VpcId *string `min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceSummary) GoString() string { + return s.String() +} + +// SetApplicationId sets the ApplicationId field's value. +func (s *ServiceSummary) SetApplicationId(v string) *ServiceSummary { + s.ApplicationId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *ServiceSummary) SetArn(v string) *ServiceSummary { + s.Arn = &v + return s +} + +// SetCreatedByAccountId sets the CreatedByAccountId field's value. +func (s *ServiceSummary) SetCreatedByAccountId(v string) *ServiceSummary { + s.CreatedByAccountId = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *ServiceSummary) SetCreatedTime(v time.Time) *ServiceSummary { + s.CreatedTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ServiceSummary) SetDescription(v string) *ServiceSummary { + s.Description = &v + return s +} + +// SetEndpointType sets the EndpointType field's value. +func (s *ServiceSummary) SetEndpointType(v string) *ServiceSummary { + s.EndpointType = &v + return s +} + +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *ServiceSummary) SetEnvironmentId(v string) *ServiceSummary { + s.EnvironmentId = &v + return s +} + +// SetError sets the Error field's value. +func (s *ServiceSummary) SetError(v *ErrorResponse) *ServiceSummary { + s.Error = v + return s +} + +// SetLambdaEndpoint sets the LambdaEndpoint field's value. +func (s *ServiceSummary) SetLambdaEndpoint(v *LambdaEndpointSummary) *ServiceSummary { + s.LambdaEndpoint = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *ServiceSummary) SetLastUpdatedTime(v time.Time) *ServiceSummary { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *ServiceSummary) SetName(v string) *ServiceSummary { + s.Name = &v + return s +} + +// SetOwnerAccountId sets the OwnerAccountId field's value. +func (s *ServiceSummary) SetOwnerAccountId(v string) *ServiceSummary { + s.OwnerAccountId = &v + return s +} + +// SetServiceId sets the ServiceId field's value. +func (s *ServiceSummary) SetServiceId(v string) *ServiceSummary { + s.ServiceId = &v + return s +} + +// SetState sets the State field's value. +func (s *ServiceSummary) SetState(v string) *ServiceSummary { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ServiceSummary) SetTags(v map[string]*string) *ServiceSummary { + s.Tags = v + return s +} + +// SetUrlEndpoint sets the UrlEndpoint field's value. +func (s *ServiceSummary) SetUrlEndpoint(v *UrlEndpointSummary) *ServiceSummary { + s.UrlEndpoint = v + return s +} + +// SetVpcId sets the VpcId field's value. +func (s *ServiceSummary) SetVpcId(v string) *ServiceSummary { + s.VpcId = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The new or modified tags for the resource. + // + // Tags is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by TagResourceInput's + // String and GoString methods. + // + // Tags is a required field + Tags map[string]*string `type:"map" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// Request was denied because the request was throttled. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // Service quota requirement to identify originating quota. Reached throttling + // quota exception. + QuotaCode *string `type:"string"` + + // The number of seconds to wait before retrying. + RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` + + // Service quota requirement to identify originating service. Reached throttling + // quota exception service code. + ServiceCode *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"ResourceArn" type:"string" required:"true"` + + // The list of keys of the tags to be removed from the resource. + // + // TagKeys is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UntagResourceInput's + // String and GoString methods. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +// The configuration for the URI path route type. +type UriPathRouteInput_ struct { + _ struct{} `type:"structure"` + + // Indicates whether traffic is forwarded to this route’s service after the + // route is created. + // + // ActivationState is a required field + ActivationState *string `type:"string" required:"true" enum:"RouteActivationState"` + + // Indicates whether to match all subpaths of the given source path. If this + // value is false, requests must match the source path exactly before they are + // forwarded to this route's service. + IncludeChildPaths *bool `type:"boolean"` + + // A list of HTTP methods to match. An empty list matches all values. If a method + // is present, only HTTP requests using that method are forwarded to this route’s + // service. + Methods []*string `type:"list"` + + // The path to use to match traffic. Paths must start with / and are relative + // to the base of the application. + // + // SourcePath is a required field + SourcePath *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UriPathRouteInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UriPathRouteInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UriPathRouteInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UriPathRouteInput_"} + if s.ActivationState == nil { + invalidParams.Add(request.NewErrParamRequired("ActivationState")) + } + if s.SourcePath == nil { + invalidParams.Add(request.NewErrParamRequired("SourcePath")) + } + if s.SourcePath != nil && len(*s.SourcePath) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourcePath", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetActivationState sets the ActivationState field's value. +func (s *UriPathRouteInput_) SetActivationState(v string) *UriPathRouteInput_ { + s.ActivationState = &v + return s +} + +// SetIncludeChildPaths sets the IncludeChildPaths field's value. +func (s *UriPathRouteInput_) SetIncludeChildPaths(v bool) *UriPathRouteInput_ { + s.IncludeChildPaths = &v + return s +} + +// SetMethods sets the Methods field's value. +func (s *UriPathRouteInput_) SetMethods(v []*string) *UriPathRouteInput_ { + s.Methods = v + return s +} + +// SetSourcePath sets the SourcePath field's value. +func (s *UriPathRouteInput_) SetSourcePath(v string) *UriPathRouteInput_ { + s.SourcePath = &v + return s +} + +// The configuration for the URL endpoint type. +type UrlEndpointConfig struct { + _ struct{} `type:"structure"` + + // The health check URL of the URL endpoint type. + HealthUrl *string `min:"1" type:"string"` + + // The HTTP URL endpoint. + Url *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointConfig) GoString() string { + return s.String() +} + +// SetHealthUrl sets the HealthUrl field's value. +func (s *UrlEndpointConfig) SetHealthUrl(v string) *UrlEndpointConfig { + s.HealthUrl = &v + return s +} + +// SetUrl sets the Url field's value. +func (s *UrlEndpointConfig) SetUrl(v string) *UrlEndpointConfig { + s.Url = &v + return s +} + +// The configuration for the URL endpoint type. +type UrlEndpointInput_ struct { + _ struct{} `type:"structure"` + + // The health check URL of the URL endpoint type. If the URL is a public endpoint, + // the HealthUrl must also be a public endpoint. If the URL is a private endpoint + // inside a virtual private cloud (VPC), the health URL must also be a private + // endpoint, and the host must be the same as the URL. + HealthUrl *string `min:"1" type:"string"` + + // The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986). + // If the host is a domain name, the name must be resolvable over the public + // internet. If the scheme is https, the top level domain of the host must be + // listed in the IANA root zone database (https://www.iana.org/domains/root/db). + // + // Url is a required field + Url *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UrlEndpointInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UrlEndpointInput_"} + if s.HealthUrl != nil && len(*s.HealthUrl) < 1 { + invalidParams.Add(request.NewErrParamMinLen("HealthUrl", 1)) + } + if s.Url == nil { + invalidParams.Add(request.NewErrParamRequired("Url")) + } + if s.Url != nil && len(*s.Url) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Url", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetHealthUrl sets the HealthUrl field's value. +func (s *UrlEndpointInput_) SetHealthUrl(v string) *UrlEndpointInput_ { + s.HealthUrl = &v + return s +} + +// SetUrl sets the Url field's value. +func (s *UrlEndpointInput_) SetUrl(v string) *UrlEndpointInput_ { + s.Url = &v + return s +} + +// The summary of the configuration for the URL endpoint type. +type UrlEndpointSummary struct { + _ struct{} `type:"structure"` + + // The health check URL of the URL endpoint type. If the URL is a public endpoint, + // the HealthUrl must also be a public endpoint. If the URL is a private endpoint + // inside a virtual private cloud (VPC), the health URL must also be a private + // endpoint, and the host must be the same as the URL. + HealthUrl *string `min:"1" type:"string"` + + // The URL to route traffic to. The URL must be an rfc3986-formatted URL (https://datatracker.ietf.org/doc/html/rfc3986). + // If the host is a domain name, the name must be resolvable over the public + // internet. If the scheme is https, the top level domain of the host must be + // listed in the IANA root zone database (https://www.iana.org/domains/root/db). + Url *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UrlEndpointSummary) GoString() string { + return s.String() +} + +// SetHealthUrl sets the HealthUrl field's value. +func (s *UrlEndpointSummary) SetHealthUrl(v string) *UrlEndpointSummary { + s.HealthUrl = &v + return s +} + +// SetUrl sets the Url field's value. +func (s *UrlEndpointSummary) SetUrl(v string) *UrlEndpointSummary { + s.Url = &v + return s +} + +// The input does not satisfy the constraints specified by an Amazon Web Service. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +const ( + // ApiGatewayEndpointTypeRegional is a ApiGatewayEndpointType enum value + ApiGatewayEndpointTypeRegional = "REGIONAL" + + // ApiGatewayEndpointTypePrivate is a ApiGatewayEndpointType enum value + ApiGatewayEndpointTypePrivate = "PRIVATE" +) + +// ApiGatewayEndpointType_Values returns all elements of the ApiGatewayEndpointType enum +func ApiGatewayEndpointType_Values() []string { + return []string{ + ApiGatewayEndpointTypeRegional, + ApiGatewayEndpointTypePrivate, + } +} + +const ( + // ApplicationStateCreating is a ApplicationState enum value + ApplicationStateCreating = "CREATING" + + // ApplicationStateActive is a ApplicationState enum value + ApplicationStateActive = "ACTIVE" + + // ApplicationStateDeleting is a ApplicationState enum value + ApplicationStateDeleting = "DELETING" + + // ApplicationStateFailed is a ApplicationState enum value + ApplicationStateFailed = "FAILED" + + // ApplicationStateUpdating is a ApplicationState enum value + ApplicationStateUpdating = "UPDATING" +) + +// ApplicationState_Values returns all elements of the ApplicationState enum +func ApplicationState_Values() []string { + return []string{ + ApplicationStateCreating, + ApplicationStateActive, + ApplicationStateDeleting, + ApplicationStateFailed, + ApplicationStateUpdating, + } +} + +const ( + // EnvironmentStateCreating is a EnvironmentState enum value + EnvironmentStateCreating = "CREATING" + + // EnvironmentStateActive is a EnvironmentState enum value + EnvironmentStateActive = "ACTIVE" + + // EnvironmentStateDeleting is a EnvironmentState enum value + EnvironmentStateDeleting = "DELETING" + + // EnvironmentStateFailed is a EnvironmentState enum value + EnvironmentStateFailed = "FAILED" +) + +// EnvironmentState_Values returns all elements of the EnvironmentState enum +func EnvironmentState_Values() []string { + return []string{ + EnvironmentStateCreating, + EnvironmentStateActive, + EnvironmentStateDeleting, + EnvironmentStateFailed, + } +} + +const ( + // ErrorCodeInvalidResourceState is a ErrorCode enum value + ErrorCodeInvalidResourceState = "INVALID_RESOURCE_STATE" + + // ErrorCodeResourceLimitExceeded is a ErrorCode enum value + ErrorCodeResourceLimitExceeded = "RESOURCE_LIMIT_EXCEEDED" + + // ErrorCodeResourceCreationFailure is a ErrorCode enum value + ErrorCodeResourceCreationFailure = "RESOURCE_CREATION_FAILURE" + + // ErrorCodeResourceUpdateFailure is a ErrorCode enum value + ErrorCodeResourceUpdateFailure = "RESOURCE_UPDATE_FAILURE" + + // ErrorCodeServiceEndpointHealthCheckFailure is a ErrorCode enum value + ErrorCodeServiceEndpointHealthCheckFailure = "SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE" + + // ErrorCodeResourceDeletionFailure is a ErrorCode enum value + ErrorCodeResourceDeletionFailure = "RESOURCE_DELETION_FAILURE" + + // ErrorCodeResourceRetrievalFailure is a ErrorCode enum value + ErrorCodeResourceRetrievalFailure = "RESOURCE_RETRIEVAL_FAILURE" + + // ErrorCodeResourceInUse is a ErrorCode enum value + ErrorCodeResourceInUse = "RESOURCE_IN_USE" + + // ErrorCodeResourceNotFound is a ErrorCode enum value + ErrorCodeResourceNotFound = "RESOURCE_NOT_FOUND" + + // ErrorCodeStateTransitionFailure is a ErrorCode enum value + ErrorCodeStateTransitionFailure = "STATE_TRANSITION_FAILURE" + + // ErrorCodeRequestLimitExceeded is a ErrorCode enum value + ErrorCodeRequestLimitExceeded = "REQUEST_LIMIT_EXCEEDED" + + // ErrorCodeNotAuthorized is a ErrorCode enum value + ErrorCodeNotAuthorized = "NOT_AUTHORIZED" +) + +// ErrorCode_Values returns all elements of the ErrorCode enum +func ErrorCode_Values() []string { + return []string{ + ErrorCodeInvalidResourceState, + ErrorCodeResourceLimitExceeded, + ErrorCodeResourceCreationFailure, + ErrorCodeResourceUpdateFailure, + ErrorCodeServiceEndpointHealthCheckFailure, + ErrorCodeResourceDeletionFailure, + ErrorCodeResourceRetrievalFailure, + ErrorCodeResourceInUse, + ErrorCodeResourceNotFound, + ErrorCodeStateTransitionFailure, + ErrorCodeRequestLimitExceeded, + ErrorCodeNotAuthorized, + } +} + +const ( + // ErrorResourceTypeEnvironment is a ErrorResourceType enum value + ErrorResourceTypeEnvironment = "ENVIRONMENT" + + // ErrorResourceTypeApplication is a ErrorResourceType enum value + ErrorResourceTypeApplication = "APPLICATION" + + // ErrorResourceTypeRoute is a ErrorResourceType enum value + ErrorResourceTypeRoute = "ROUTE" + + // ErrorResourceTypeService is a ErrorResourceType enum value + ErrorResourceTypeService = "SERVICE" + + // ErrorResourceTypeTransitGateway is a ErrorResourceType enum value + ErrorResourceTypeTransitGateway = "TRANSIT_GATEWAY" + + // ErrorResourceTypeTransitGatewayAttachment is a ErrorResourceType enum value + ErrorResourceTypeTransitGatewayAttachment = "TRANSIT_GATEWAY_ATTACHMENT" + + // ErrorResourceTypeApiGateway is a ErrorResourceType enum value + ErrorResourceTypeApiGateway = "API_GATEWAY" + + // ErrorResourceTypeNlb is a ErrorResourceType enum value + ErrorResourceTypeNlb = "NLB" + + // ErrorResourceTypeTargetGroup is a ErrorResourceType enum value + ErrorResourceTypeTargetGroup = "TARGET_GROUP" + + // ErrorResourceTypeLoadBalancerListener is a ErrorResourceType enum value + ErrorResourceTypeLoadBalancerListener = "LOAD_BALANCER_LISTENER" + + // ErrorResourceTypeVpcLink is a ErrorResourceType enum value + ErrorResourceTypeVpcLink = "VPC_LINK" + + // ErrorResourceTypeLambda is a ErrorResourceType enum value + ErrorResourceTypeLambda = "LAMBDA" + + // ErrorResourceTypeVpc is a ErrorResourceType enum value + ErrorResourceTypeVpc = "VPC" + + // ErrorResourceTypeSubnet is a ErrorResourceType enum value + ErrorResourceTypeSubnet = "SUBNET" + + // ErrorResourceTypeRouteTable is a ErrorResourceType enum value + ErrorResourceTypeRouteTable = "ROUTE_TABLE" + + // ErrorResourceTypeSecurityGroup is a ErrorResourceType enum value + ErrorResourceTypeSecurityGroup = "SECURITY_GROUP" + + // ErrorResourceTypeVpcEndpointServiceConfiguration is a ErrorResourceType enum value + ErrorResourceTypeVpcEndpointServiceConfiguration = "VPC_ENDPOINT_SERVICE_CONFIGURATION" + + // ErrorResourceTypeResourceShare is a ErrorResourceType enum value + ErrorResourceTypeResourceShare = "RESOURCE_SHARE" + + // ErrorResourceTypeIamRole is a ErrorResourceType enum value + ErrorResourceTypeIamRole = "IAM_ROLE" +) + +// ErrorResourceType_Values returns all elements of the ErrorResourceType enum +func ErrorResourceType_Values() []string { + return []string{ + ErrorResourceTypeEnvironment, + ErrorResourceTypeApplication, + ErrorResourceTypeRoute, + ErrorResourceTypeService, + ErrorResourceTypeTransitGateway, + ErrorResourceTypeTransitGatewayAttachment, + ErrorResourceTypeApiGateway, + ErrorResourceTypeNlb, + ErrorResourceTypeTargetGroup, + ErrorResourceTypeLoadBalancerListener, + ErrorResourceTypeVpcLink, + ErrorResourceTypeLambda, + ErrorResourceTypeVpc, + ErrorResourceTypeSubnet, + ErrorResourceTypeRouteTable, + ErrorResourceTypeSecurityGroup, + ErrorResourceTypeVpcEndpointServiceConfiguration, + ErrorResourceTypeResourceShare, + ErrorResourceTypeIamRole, + } +} + +const ( + // HttpMethodDelete is a HttpMethod enum value + HttpMethodDelete = "DELETE" + + // HttpMethodGet is a HttpMethod enum value + HttpMethodGet = "GET" + + // HttpMethodHead is a HttpMethod enum value + HttpMethodHead = "HEAD" + + // HttpMethodOptions is a HttpMethod enum value + HttpMethodOptions = "OPTIONS" + + // HttpMethodPatch is a HttpMethod enum value + HttpMethodPatch = "PATCH" + + // HttpMethodPost is a HttpMethod enum value + HttpMethodPost = "POST" + + // HttpMethodPut is a HttpMethod enum value + HttpMethodPut = "PUT" +) + +// HttpMethod_Values returns all elements of the HttpMethod enum +func HttpMethod_Values() []string { + return []string{ + HttpMethodDelete, + HttpMethodGet, + HttpMethodHead, + HttpMethodOptions, + HttpMethodPatch, + HttpMethodPost, + HttpMethodPut, + } +} + +const ( + // NetworkFabricTypeTransitGateway is a NetworkFabricType enum value + NetworkFabricTypeTransitGateway = "TRANSIT_GATEWAY" +) + +// NetworkFabricType_Values returns all elements of the NetworkFabricType enum +func NetworkFabricType_Values() []string { + return []string{ + NetworkFabricTypeTransitGateway, + } +} + +const ( + // ProxyTypeApiGateway is a ProxyType enum value + ProxyTypeApiGateway = "API_GATEWAY" +) + +// ProxyType_Values returns all elements of the ProxyType enum +func ProxyType_Values() []string { + return []string{ + ProxyTypeApiGateway, + } +} + +const ( + // RouteActivationStateActive is a RouteActivationState enum value + RouteActivationStateActive = "ACTIVE" +) + +// RouteActivationState_Values returns all elements of the RouteActivationState enum +func RouteActivationState_Values() []string { + return []string{ + RouteActivationStateActive, + } +} + +const ( + // RouteStateCreating is a RouteState enum value + RouteStateCreating = "CREATING" + + // RouteStateActive is a RouteState enum value + RouteStateActive = "ACTIVE" + + // RouteStateDeleting is a RouteState enum value + RouteStateDeleting = "DELETING" + + // RouteStateFailed is a RouteState enum value + RouteStateFailed = "FAILED" + + // RouteStateUpdating is a RouteState enum value + RouteStateUpdating = "UPDATING" + + // RouteStateInactive is a RouteState enum value + RouteStateInactive = "INACTIVE" +) + +// RouteState_Values returns all elements of the RouteState enum +func RouteState_Values() []string { + return []string{ + RouteStateCreating, + RouteStateActive, + RouteStateDeleting, + RouteStateFailed, + RouteStateUpdating, + RouteStateInactive, + } +} + +const ( + // RouteTypeDefault is a RouteType enum value + RouteTypeDefault = "DEFAULT" + + // RouteTypeUriPath is a RouteType enum value + RouteTypeUriPath = "URI_PATH" +) + +// RouteType_Values returns all elements of the RouteType enum +func RouteType_Values() []string { + return []string{ + RouteTypeDefault, + RouteTypeUriPath, + } +} + +const ( + // ServiceEndpointTypeLambda is a ServiceEndpointType enum value + ServiceEndpointTypeLambda = "LAMBDA" + + // ServiceEndpointTypeUrl is a ServiceEndpointType enum value + ServiceEndpointTypeUrl = "URL" +) + +// ServiceEndpointType_Values returns all elements of the ServiceEndpointType enum +func ServiceEndpointType_Values() []string { + return []string{ + ServiceEndpointTypeLambda, + ServiceEndpointTypeUrl, + } +} + +const ( + // ServiceStateCreating is a ServiceState enum value + ServiceStateCreating = "CREATING" + + // ServiceStateActive is a ServiceState enum value + ServiceStateActive = "ACTIVE" + + // ServiceStateDeleting is a ServiceState enum value + ServiceStateDeleting = "DELETING" + + // ServiceStateFailed is a ServiceState enum value + ServiceStateFailed = "FAILED" +) + +// ServiceState_Values returns all elements of the ServiceState enum +func ServiceState_Values() []string { + return []string{ + ServiceStateCreating, + ServiceStateActive, + ServiceStateDeleting, + ServiceStateFailed, + } +} diff --git a/service/migrationhubrefactorspaces/doc.go b/service/migrationhubrefactorspaces/doc.go new file mode 100644 index 00000000000..acc96786ef7 --- /dev/null +++ b/service/migrationhubrefactorspaces/doc.go @@ -0,0 +1,35 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package migrationhubrefactorspaces provides the client and types for making API +// requests to AWS Migration Hub Refactor Spaces. +// +// +//This API reference provides descriptions, syntax, and other details +// about each of the actions and data types for Amazon Web Services Migration +// Hub Refactor Spaces (Refactor Spaces). The topic for each action shows +// the API request parameters and the response. Alternatively, you can use +// one of the Amazon Web Services SDKs to access an API that is tailored +// to the programming language or platform that you're using. For more information, +// see Amazon Web Services SDKs.
+// +// See https://docs.aws.amazon.com/goto/WebAPI/migration-hub-refactor-spaces-2021-10-26 for more information on this service. +// +// See migrationhubrefactorspaces package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/migrationhubrefactorspaces/ +// +// Using the Client +// +// To contact AWS Migration Hub Refactor Spaces with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the AWS Migration Hub Refactor Spaces client MigrationHubRefactorSpaces for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/migrationhubrefactorspaces/#New +package migrationhubrefactorspaces diff --git a/service/migrationhubrefactorspaces/errors.go b/service/migrationhubrefactorspaces/errors.go new file mode 100644 index 00000000000..7d9555e4f32 --- /dev/null +++ b/service/migrationhubrefactorspaces/errors.go @@ -0,0 +1,69 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package migrationhubrefactorspaces + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // The user does not have sufficient access to perform this action. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // Updating or deleting a resource can cause an inconsistent state. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // An unexpected error occurred while processing the request. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeInvalidResourcePolicyException for service response error code + // "InvalidResourcePolicyException". + // + // The resource policy is not valid. + ErrCodeInvalidResourcePolicyException = "InvalidResourcePolicyException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The request references a resource that does not exist. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // The request would cause a service quota to be exceeded. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // Request was denied because the request was throttled. + ErrCodeThrottlingException = "ThrottlingException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The input does not satisfy the constraints specified by an Amazon Web Service. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "InvalidResourcePolicyException": newErrorInvalidResourcePolicyException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, + "ValidationException": newErrorValidationException, +} diff --git a/service/migrationhubrefactorspaces/migrationhubrefactorspacesiface/interface.go b/service/migrationhubrefactorspaces/migrationhubrefactorspacesiface/interface.go new file mode 100644 index 00000000000..ec9ab306a20 --- /dev/null +++ b/service/migrationhubrefactorspaces/migrationhubrefactorspacesiface/interface.go @@ -0,0 +1,171 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package migrationhubrefactorspacesiface provides an interface to enable mocking the AWS Migration Hub Refactor Spaces service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package migrationhubrefactorspacesiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/migrationhubrefactorspaces" +) + +// MigrationHubRefactorSpacesAPI provides an interface to enable mocking the +// migrationhubrefactorspaces.MigrationHubRefactorSpaces service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // AWS Migration Hub Refactor Spaces. +// func myFunc(svc migrationhubrefactorspacesiface.MigrationHubRefactorSpacesAPI) bool { +// // Make svc.CreateApplication request +// } +// +// func main() { +// sess := session.New() +// svc := migrationhubrefactorspaces.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockMigrationHubRefactorSpacesClient struct { +// migrationhubrefactorspacesiface.MigrationHubRefactorSpacesAPI +// } +// func (m *mockMigrationHubRefactorSpacesClient) CreateApplication(input *migrationhubrefactorspaces.CreateApplicationInput) (*migrationhubrefactorspaces.CreateApplicationOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockMigrationHubRefactorSpacesClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type MigrationHubRefactorSpacesAPI interface { + CreateApplication(*migrationhubrefactorspaces.CreateApplicationInput) (*migrationhubrefactorspaces.CreateApplicationOutput, error) + CreateApplicationWithContext(aws.Context, *migrationhubrefactorspaces.CreateApplicationInput, ...request.Option) (*migrationhubrefactorspaces.CreateApplicationOutput, error) + CreateApplicationRequest(*migrationhubrefactorspaces.CreateApplicationInput) (*request.Request, *migrationhubrefactorspaces.CreateApplicationOutput) + + CreateEnvironment(*migrationhubrefactorspaces.CreateEnvironmentInput) (*migrationhubrefactorspaces.CreateEnvironmentOutput, error) + CreateEnvironmentWithContext(aws.Context, *migrationhubrefactorspaces.CreateEnvironmentInput, ...request.Option) (*migrationhubrefactorspaces.CreateEnvironmentOutput, error) + CreateEnvironmentRequest(*migrationhubrefactorspaces.CreateEnvironmentInput) (*request.Request, *migrationhubrefactorspaces.CreateEnvironmentOutput) + + CreateRoute(*migrationhubrefactorspaces.CreateRouteInput) (*migrationhubrefactorspaces.CreateRouteOutput, error) + CreateRouteWithContext(aws.Context, *migrationhubrefactorspaces.CreateRouteInput, ...request.Option) (*migrationhubrefactorspaces.CreateRouteOutput, error) + CreateRouteRequest(*migrationhubrefactorspaces.CreateRouteInput) (*request.Request, *migrationhubrefactorspaces.CreateRouteOutput) + + CreateService(*migrationhubrefactorspaces.CreateServiceInput) (*migrationhubrefactorspaces.CreateServiceOutput, error) + CreateServiceWithContext(aws.Context, *migrationhubrefactorspaces.CreateServiceInput, ...request.Option) (*migrationhubrefactorspaces.CreateServiceOutput, error) + CreateServiceRequest(*migrationhubrefactorspaces.CreateServiceInput) (*request.Request, *migrationhubrefactorspaces.CreateServiceOutput) + + DeleteApplication(*migrationhubrefactorspaces.DeleteApplicationInput) (*migrationhubrefactorspaces.DeleteApplicationOutput, error) + DeleteApplicationWithContext(aws.Context, *migrationhubrefactorspaces.DeleteApplicationInput, ...request.Option) (*migrationhubrefactorspaces.DeleteApplicationOutput, error) + DeleteApplicationRequest(*migrationhubrefactorspaces.DeleteApplicationInput) (*request.Request, *migrationhubrefactorspaces.DeleteApplicationOutput) + + DeleteEnvironment(*migrationhubrefactorspaces.DeleteEnvironmentInput) (*migrationhubrefactorspaces.DeleteEnvironmentOutput, error) + DeleteEnvironmentWithContext(aws.Context, *migrationhubrefactorspaces.DeleteEnvironmentInput, ...request.Option) (*migrationhubrefactorspaces.DeleteEnvironmentOutput, error) + DeleteEnvironmentRequest(*migrationhubrefactorspaces.DeleteEnvironmentInput) (*request.Request, *migrationhubrefactorspaces.DeleteEnvironmentOutput) + + DeleteResourcePolicy(*migrationhubrefactorspaces.DeleteResourcePolicyInput) (*migrationhubrefactorspaces.DeleteResourcePolicyOutput, error) + DeleteResourcePolicyWithContext(aws.Context, *migrationhubrefactorspaces.DeleteResourcePolicyInput, ...request.Option) (*migrationhubrefactorspaces.DeleteResourcePolicyOutput, error) + DeleteResourcePolicyRequest(*migrationhubrefactorspaces.DeleteResourcePolicyInput) (*request.Request, *migrationhubrefactorspaces.DeleteResourcePolicyOutput) + + DeleteRoute(*migrationhubrefactorspaces.DeleteRouteInput) (*migrationhubrefactorspaces.DeleteRouteOutput, error) + DeleteRouteWithContext(aws.Context, *migrationhubrefactorspaces.DeleteRouteInput, ...request.Option) (*migrationhubrefactorspaces.DeleteRouteOutput, error) + DeleteRouteRequest(*migrationhubrefactorspaces.DeleteRouteInput) (*request.Request, *migrationhubrefactorspaces.DeleteRouteOutput) + + DeleteService(*migrationhubrefactorspaces.DeleteServiceInput) (*migrationhubrefactorspaces.DeleteServiceOutput, error) + DeleteServiceWithContext(aws.Context, *migrationhubrefactorspaces.DeleteServiceInput, ...request.Option) (*migrationhubrefactorspaces.DeleteServiceOutput, error) + DeleteServiceRequest(*migrationhubrefactorspaces.DeleteServiceInput) (*request.Request, *migrationhubrefactorspaces.DeleteServiceOutput) + + GetApplication(*migrationhubrefactorspaces.GetApplicationInput) (*migrationhubrefactorspaces.GetApplicationOutput, error) + GetApplicationWithContext(aws.Context, *migrationhubrefactorspaces.GetApplicationInput, ...request.Option) (*migrationhubrefactorspaces.GetApplicationOutput, error) + GetApplicationRequest(*migrationhubrefactorspaces.GetApplicationInput) (*request.Request, *migrationhubrefactorspaces.GetApplicationOutput) + + GetEnvironment(*migrationhubrefactorspaces.GetEnvironmentInput) (*migrationhubrefactorspaces.GetEnvironmentOutput, error) + GetEnvironmentWithContext(aws.Context, *migrationhubrefactorspaces.GetEnvironmentInput, ...request.Option) (*migrationhubrefactorspaces.GetEnvironmentOutput, error) + GetEnvironmentRequest(*migrationhubrefactorspaces.GetEnvironmentInput) (*request.Request, *migrationhubrefactorspaces.GetEnvironmentOutput) + + GetResourcePolicy(*migrationhubrefactorspaces.GetResourcePolicyInput) (*migrationhubrefactorspaces.GetResourcePolicyOutput, error) + GetResourcePolicyWithContext(aws.Context, *migrationhubrefactorspaces.GetResourcePolicyInput, ...request.Option) (*migrationhubrefactorspaces.GetResourcePolicyOutput, error) + GetResourcePolicyRequest(*migrationhubrefactorspaces.GetResourcePolicyInput) (*request.Request, *migrationhubrefactorspaces.GetResourcePolicyOutput) + + GetRoute(*migrationhubrefactorspaces.GetRouteInput) (*migrationhubrefactorspaces.GetRouteOutput, error) + GetRouteWithContext(aws.Context, *migrationhubrefactorspaces.GetRouteInput, ...request.Option) (*migrationhubrefactorspaces.GetRouteOutput, error) + GetRouteRequest(*migrationhubrefactorspaces.GetRouteInput) (*request.Request, *migrationhubrefactorspaces.GetRouteOutput) + + GetService(*migrationhubrefactorspaces.GetServiceInput) (*migrationhubrefactorspaces.GetServiceOutput, error) + GetServiceWithContext(aws.Context, *migrationhubrefactorspaces.GetServiceInput, ...request.Option) (*migrationhubrefactorspaces.GetServiceOutput, error) + GetServiceRequest(*migrationhubrefactorspaces.GetServiceInput) (*request.Request, *migrationhubrefactorspaces.GetServiceOutput) + + ListApplications(*migrationhubrefactorspaces.ListApplicationsInput) (*migrationhubrefactorspaces.ListApplicationsOutput, error) + ListApplicationsWithContext(aws.Context, *migrationhubrefactorspaces.ListApplicationsInput, ...request.Option) (*migrationhubrefactorspaces.ListApplicationsOutput, error) + ListApplicationsRequest(*migrationhubrefactorspaces.ListApplicationsInput) (*request.Request, *migrationhubrefactorspaces.ListApplicationsOutput) + + ListApplicationsPages(*migrationhubrefactorspaces.ListApplicationsInput, func(*migrationhubrefactorspaces.ListApplicationsOutput, bool) bool) error + ListApplicationsPagesWithContext(aws.Context, *migrationhubrefactorspaces.ListApplicationsInput, func(*migrationhubrefactorspaces.ListApplicationsOutput, bool) bool, ...request.Option) error + + ListEnvironmentVpcs(*migrationhubrefactorspaces.ListEnvironmentVpcsInput) (*migrationhubrefactorspaces.ListEnvironmentVpcsOutput, error) + ListEnvironmentVpcsWithContext(aws.Context, *migrationhubrefactorspaces.ListEnvironmentVpcsInput, ...request.Option) (*migrationhubrefactorspaces.ListEnvironmentVpcsOutput, error) + ListEnvironmentVpcsRequest(*migrationhubrefactorspaces.ListEnvironmentVpcsInput) (*request.Request, *migrationhubrefactorspaces.ListEnvironmentVpcsOutput) + + ListEnvironmentVpcsPages(*migrationhubrefactorspaces.ListEnvironmentVpcsInput, func(*migrationhubrefactorspaces.ListEnvironmentVpcsOutput, bool) bool) error + ListEnvironmentVpcsPagesWithContext(aws.Context, *migrationhubrefactorspaces.ListEnvironmentVpcsInput, func(*migrationhubrefactorspaces.ListEnvironmentVpcsOutput, bool) bool, ...request.Option) error + + ListEnvironments(*migrationhubrefactorspaces.ListEnvironmentsInput) (*migrationhubrefactorspaces.ListEnvironmentsOutput, error) + ListEnvironmentsWithContext(aws.Context, *migrationhubrefactorspaces.ListEnvironmentsInput, ...request.Option) (*migrationhubrefactorspaces.ListEnvironmentsOutput, error) + ListEnvironmentsRequest(*migrationhubrefactorspaces.ListEnvironmentsInput) (*request.Request, *migrationhubrefactorspaces.ListEnvironmentsOutput) + + ListEnvironmentsPages(*migrationhubrefactorspaces.ListEnvironmentsInput, func(*migrationhubrefactorspaces.ListEnvironmentsOutput, bool) bool) error + ListEnvironmentsPagesWithContext(aws.Context, *migrationhubrefactorspaces.ListEnvironmentsInput, func(*migrationhubrefactorspaces.ListEnvironmentsOutput, bool) bool, ...request.Option) error + + ListRoutes(*migrationhubrefactorspaces.ListRoutesInput) (*migrationhubrefactorspaces.ListRoutesOutput, error) + ListRoutesWithContext(aws.Context, *migrationhubrefactorspaces.ListRoutesInput, ...request.Option) (*migrationhubrefactorspaces.ListRoutesOutput, error) + ListRoutesRequest(*migrationhubrefactorspaces.ListRoutesInput) (*request.Request, *migrationhubrefactorspaces.ListRoutesOutput) + + ListRoutesPages(*migrationhubrefactorspaces.ListRoutesInput, func(*migrationhubrefactorspaces.ListRoutesOutput, bool) bool) error + ListRoutesPagesWithContext(aws.Context, *migrationhubrefactorspaces.ListRoutesInput, func(*migrationhubrefactorspaces.ListRoutesOutput, bool) bool, ...request.Option) error + + ListServices(*migrationhubrefactorspaces.ListServicesInput) (*migrationhubrefactorspaces.ListServicesOutput, error) + ListServicesWithContext(aws.Context, *migrationhubrefactorspaces.ListServicesInput, ...request.Option) (*migrationhubrefactorspaces.ListServicesOutput, error) + ListServicesRequest(*migrationhubrefactorspaces.ListServicesInput) (*request.Request, *migrationhubrefactorspaces.ListServicesOutput) + + ListServicesPages(*migrationhubrefactorspaces.ListServicesInput, func(*migrationhubrefactorspaces.ListServicesOutput, bool) bool) error + ListServicesPagesWithContext(aws.Context, *migrationhubrefactorspaces.ListServicesInput, func(*migrationhubrefactorspaces.ListServicesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*migrationhubrefactorspaces.ListTagsForResourceInput) (*migrationhubrefactorspaces.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *migrationhubrefactorspaces.ListTagsForResourceInput, ...request.Option) (*migrationhubrefactorspaces.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*migrationhubrefactorspaces.ListTagsForResourceInput) (*request.Request, *migrationhubrefactorspaces.ListTagsForResourceOutput) + + PutResourcePolicy(*migrationhubrefactorspaces.PutResourcePolicyInput) (*migrationhubrefactorspaces.PutResourcePolicyOutput, error) + PutResourcePolicyWithContext(aws.Context, *migrationhubrefactorspaces.PutResourcePolicyInput, ...request.Option) (*migrationhubrefactorspaces.PutResourcePolicyOutput, error) + PutResourcePolicyRequest(*migrationhubrefactorspaces.PutResourcePolicyInput) (*request.Request, *migrationhubrefactorspaces.PutResourcePolicyOutput) + + TagResource(*migrationhubrefactorspaces.TagResourceInput) (*migrationhubrefactorspaces.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *migrationhubrefactorspaces.TagResourceInput, ...request.Option) (*migrationhubrefactorspaces.TagResourceOutput, error) + TagResourceRequest(*migrationhubrefactorspaces.TagResourceInput) (*request.Request, *migrationhubrefactorspaces.TagResourceOutput) + + UntagResource(*migrationhubrefactorspaces.UntagResourceInput) (*migrationhubrefactorspaces.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *migrationhubrefactorspaces.UntagResourceInput, ...request.Option) (*migrationhubrefactorspaces.UntagResourceOutput, error) + UntagResourceRequest(*migrationhubrefactorspaces.UntagResourceInput) (*request.Request, *migrationhubrefactorspaces.UntagResourceOutput) +} + +var _ MigrationHubRefactorSpacesAPI = (*migrationhubrefactorspaces.MigrationHubRefactorSpaces)(nil) diff --git a/service/migrationhubrefactorspaces/service.go b/service/migrationhubrefactorspaces/service.go new file mode 100644 index 00000000000..48aa1d973dd --- /dev/null +++ b/service/migrationhubrefactorspaces/service.go @@ -0,0 +1,105 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package migrationhubrefactorspaces + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// MigrationHubRefactorSpaces provides the API operation methods for making requests to +// AWS Migration Hub Refactor Spaces. See this package's package overview docs +// for details on the service. +// +// MigrationHubRefactorSpaces methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type MigrationHubRefactorSpaces struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Migration Hub Refactor Spaces" // Name of service. + EndpointsID = "refactor-spaces" // ID to lookup a service endpoint with. + ServiceID = "Migration Hub Refactor Spaces" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the MigrationHubRefactorSpaces client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a MigrationHubRefactorSpaces client from just a session. +// svc := migrationhubrefactorspaces.New(mySession) +// +// // Create a MigrationHubRefactorSpaces client with additional configuration +// svc := migrationhubrefactorspaces.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *MigrationHubRefactorSpaces { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "refactor-spaces" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *MigrationHubRefactorSpaces { + svc := &MigrationHubRefactorSpaces{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2021-10-26", + ResolvedRegion: resolvedRegion, + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a MigrationHubRefactorSpaces operation and runs any +// custom request initialization. +func (c *MigrationHubRefactorSpaces) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/personalize/api.go b/service/personalize/api.go index 1e215f3e7e2..8fec9fecf8f 100644 --- a/service/personalize/api.go +++ b/service/personalize/api.go @@ -106,6 +106,98 @@ func (c *Personalize) CreateBatchInferenceJobWithContext(ctx aws.Context, input return out, req.Send() } +const opCreateBatchSegmentJob = "CreateBatchSegmentJob" + +// CreateBatchSegmentJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateBatchSegmentJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateBatchSegmentJob for more information on using the CreateBatchSegmentJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateBatchSegmentJobRequest method. +// req, resp := client.CreateBatchSegmentJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJob +func (c *Personalize) CreateBatchSegmentJobRequest(input *CreateBatchSegmentJobInput) (req *request.Request, output *CreateBatchSegmentJobOutput) { + op := &request.Operation{ + Name: opCreateBatchSegmentJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateBatchSegmentJobInput{} + } + + output = &CreateBatchSegmentJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateBatchSegmentJob API operation for Amazon Personalize. +// +// Creates a batch segment job. The operation can handle up to 50 million records +// and the input file must be in JSON format. For more information, see recommendations-batch. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation CreateBatchSegmentJob for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceAlreadyExistsException +// The specified resource already exists. +// +// * LimitExceededException +// The limit on the number of requests per second has been exceeded. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// * ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchSegmentJob +func (c *Personalize) CreateBatchSegmentJob(input *CreateBatchSegmentJobInput) (*CreateBatchSegmentJobOutput, error) { + req, out := c.CreateBatchSegmentJobRequest(input) + return out, req.Send() +} + +// CreateBatchSegmentJobWithContext is the same as CreateBatchSegmentJob with the addition of +// the ability to pass a context and additional request options. +// +// See CreateBatchSegmentJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) CreateBatchSegmentJobWithContext(ctx aws.Context, input *CreateBatchSegmentJobInput, opts ...request.Option) (*CreateBatchSegmentJobOutput, error) { + req, out := c.CreateBatchSegmentJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateCampaign = "CreateCampaign" // CreateCampaignRequest generates a "aws/request.Request" representing the @@ -150,7 +242,7 @@ func (c *Personalize) CreateCampaignRequest(input *CreateCampaignInput) (req *re // CreateCampaign API operation for Amazon Personalize. // -// Creates a campaign by deploying a solution version. When a client calls the +// Creates a campaign that deploys a solution version. When a client calls the // GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) // and GetPersonalizedRanking (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html) // APIs, a campaign is specified in the request. @@ -515,9 +607,9 @@ func (c *Personalize) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) // CreateDatasetGroup API operation for Amazon Personalize. // -// Creates an empty dataset group. A dataset group contains related datasets -// that supply data for training a model. A dataset group can contain at most -// three datasets, one for each type of dataset: +// Creates an empty dataset group. A dataset group is a container for Amazon +// Personalize resources. A dataset group can contain at most three datasets, +// one for each type of dataset: // // * Interactions // @@ -525,8 +617,12 @@ func (c *Personalize) CreateDatasetGroupRequest(input *CreateDatasetGroupInput) // // * Users // -// To train a model (create a solution), a dataset group that contains an Interactions -// dataset is required. Call CreateDataset to add a dataset to the group. +// A dataset group can be a Domain dataset group, where you specify a domain +// and use pre-configured resources like recommenders, or a Custom dataset group, +// where you use custom resources, such as a solution with a solution version, +// that you deploy with a campaign. If you start with a Domain dataset group, +// you can still add custom resources such as solutions and solution versions +// trained with recipes for custom use cases and deployed with campaigns. // // A dataset group can be in one of the following states: // @@ -929,6 +1025,121 @@ func (c *Personalize) CreateFilterWithContext(ctx aws.Context, input *CreateFilt return out, req.Send() } +const opCreateRecommender = "CreateRecommender" + +// CreateRecommenderRequest generates a "aws/request.Request" representing the +// client's request for the CreateRecommender operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateRecommender for more information on using the CreateRecommender +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateRecommenderRequest method. +// req, resp := client.CreateRecommenderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommender +func (c *Personalize) CreateRecommenderRequest(input *CreateRecommenderInput) (req *request.Request, output *CreateRecommenderOutput) { + op := &request.Operation{ + Name: opCreateRecommender, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateRecommenderInput{} + } + + output = &CreateRecommenderOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateRecommender API operation for Amazon Personalize. +// +// Creates a recommender with the recipe (a Domain dataset group use case) you +// specify. You create recommenders for a Domain dataset group and specify the +// recommender's Amazon Resource Name (ARN) when you make a GetRecommendations +// (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// request. +// +// Status +// +// A recommender can be in one of the following states: +// +// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// +// * DELETE PENDING > DELETE IN_PROGRESS +// +// To get the recommender status, call DescribeRecommender. +// +// Wait until the status of the recommender is ACTIVE before asking the recommender +// for recommendations. +// +// Related APIs +// +// * ListRecommenders +// +// * DescribeRecommender +// +// * UpdateRecommender +// +// * DeleteRecommender +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation CreateRecommender for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceAlreadyExistsException +// The specified resource already exists. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// * LimitExceededException +// The limit on the number of requests per second has been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateRecommender +func (c *Personalize) CreateRecommender(input *CreateRecommenderInput) (*CreateRecommenderOutput, error) { + req, out := c.CreateRecommenderRequest(input) + return out, req.Send() +} + +// CreateRecommenderWithContext is the same as CreateRecommender with the addition of +// the ability to pass a context and additional request options. +// +// See CreateRecommender for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) CreateRecommenderWithContext(ctx aws.Context, input *CreateRecommenderInput, opts ...request.Option) (*CreateRecommenderOutput, error) { + req, out := c.CreateRecommenderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateSchema = "CreateSchema" // CreateSchemaRequest generates a "aws/request.Request" representing the @@ -977,8 +1188,10 @@ func (c *Personalize) CreateSchemaRequest(input *CreateSchemaInput) (req *reques // schema you create must be in Avro JSON format. // // Amazon Personalize recognizes three schema variants. Each schema is associated -// with a dataset type and has a set of required field and keywords. You specify -// a schema when you call CreateDataset. +// with a dataset type and has a set of required field and keywords. If you +// are creating a schema for a dataset in a Domain dataset group, you provide +// the domain of the Domain dataset group. You specify a schema when you call +// CreateDataset. // // Related APIs // @@ -1207,9 +1420,10 @@ func (c *Personalize) CreateSolutionVersionRequest(input *CreateSolutionVersionI // CreateSolutionVersion API operation for Amazon Personalize. // -// Trains or retrains an active solution. A solution is created using the CreateSolution -// operation and must be in the ACTIVE state before calling CreateSolutionVersion. -// A new version of the solution is created every time you call this operation. +// Trains or retrains an active solution in a Custom dataset group. A solution +// is created using the CreateSolution operation and must be in the ACTIVE state +// before calling CreateSolutionVersion. A new version of the solution is created +// every time you call this operation. // // Status // @@ -1733,6 +1947,94 @@ func (c *Personalize) DeleteFilterWithContext(ctx aws.Context, input *DeleteFilt return out, req.Send() } +const opDeleteRecommender = "DeleteRecommender" + +// DeleteRecommenderRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRecommender operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteRecommender for more information on using the DeleteRecommender +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteRecommenderRequest method. +// req, resp := client.DeleteRecommenderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommender +func (c *Personalize) DeleteRecommenderRequest(input *DeleteRecommenderInput) (req *request.Request, output *DeleteRecommenderOutput) { + op := &request.Operation{ + Name: opDeleteRecommender, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteRecommenderInput{} + } + + output = &DeleteRecommenderOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteRecommender API operation for Amazon Personalize. +// +// Deactivates and removes a recommender. A deleted recommender can no longer +// be specified in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// request. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation DeleteRecommender for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// * ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteRecommender +func (c *Personalize) DeleteRecommender(input *DeleteRecommenderInput) (*DeleteRecommenderOutput, error) { + req, out := c.DeleteRecommenderRequest(input) + return out, req.Send() +} + +// DeleteRecommenderWithContext is the same as DeleteRecommender with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRecommender for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) DeleteRecommenderWithContext(ctx aws.Context, input *DeleteRecommenderInput, opts ...request.Option) (*DeleteRecommenderOutput, error) { + req, out := c.DeleteRecommenderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteSchema = "DeleteSchema" // DeleteSchemaRequest generates a "aws/request.Request" representing the @@ -2077,69 +2379,60 @@ func (c *Personalize) DescribeBatchInferenceJobWithContext(ctx aws.Context, inpu return out, req.Send() } -const opDescribeCampaign = "DescribeCampaign" +const opDescribeBatchSegmentJob = "DescribeBatchSegmentJob" -// DescribeCampaignRequest generates a "aws/request.Request" representing the -// client's request for the DescribeCampaign operation. The "output" return +// DescribeBatchSegmentJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeBatchSegmentJob operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DescribeCampaign for more information on using the DescribeCampaign +// See DescribeBatchSegmentJob for more information on using the DescribeBatchSegmentJob // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the DescribeCampaignRequest method. -// req, resp := client.DescribeCampaignRequest(params) +// // Example sending a request using the DescribeBatchSegmentJobRequest method. +// req, resp := client.DescribeBatchSegmentJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign -func (c *Personalize) DescribeCampaignRequest(input *DescribeCampaignInput) (req *request.Request, output *DescribeCampaignOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob +func (c *Personalize) DescribeBatchSegmentJobRequest(input *DescribeBatchSegmentJobInput) (req *request.Request, output *DescribeBatchSegmentJobOutput) { op := &request.Operation{ - Name: opDescribeCampaign, + Name: opDescribeBatchSegmentJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeCampaignInput{} + input = &DescribeBatchSegmentJobInput{} } - output = &DescribeCampaignOutput{} + output = &DescribeBatchSegmentJobOutput{} req = c.newRequest(op, input, output) return } -// DescribeCampaign API operation for Amazon Personalize. -// -// Describes the given campaign, including its status. -// -// A campaign can be in one of the following states: -// -// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED -// -// * DELETE PENDING > DELETE IN_PROGRESS -// -// When the status is CREATE FAILED, the response includes the failureReason -// key, which describes why. +// DescribeBatchSegmentJob API operation for Amazon Personalize. // -// For more information on campaigns, see CreateCampaign. +// Gets the properties of a batch segment job including name, Amazon Resource +// Name (ARN), status, input and output configurations, and the ARN of the solution +// version used to generate segments. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Personalize's -// API operation DescribeCampaign for usage and error information. +// API operation DescribeBatchSegmentJob for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -2148,32 +2441,125 @@ func (c *Personalize) DescribeCampaignRequest(input *DescribeCampaignInput) (req // * ResourceNotFoundException // Could not find the specified resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign -func (c *Personalize) DescribeCampaign(input *DescribeCampaignInput) (*DescribeCampaignOutput, error) { - req, out := c.DescribeCampaignRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob +func (c *Personalize) DescribeBatchSegmentJob(input *DescribeBatchSegmentJobInput) (*DescribeBatchSegmentJobOutput, error) { + req, out := c.DescribeBatchSegmentJobRequest(input) return out, req.Send() } -// DescribeCampaignWithContext is the same as DescribeCampaign with the addition of +// DescribeBatchSegmentJobWithContext is the same as DescribeBatchSegmentJob with the addition of // the ability to pass a context and additional request options. // -// See DescribeCampaign for details on how to use this API operation. +// See DescribeBatchSegmentJob for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) DescribeCampaignWithContext(ctx aws.Context, input *DescribeCampaignInput, opts ...request.Option) (*DescribeCampaignOutput, error) { - req, out := c.DescribeCampaignRequest(input) +func (c *Personalize) DescribeBatchSegmentJobWithContext(ctx aws.Context, input *DescribeBatchSegmentJobInput, opts ...request.Option) (*DescribeBatchSegmentJobOutput, error) { + req, out := c.DescribeBatchSegmentJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeDataset = "DescribeDataset" +const opDescribeCampaign = "DescribeCampaign" -// DescribeDatasetRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDataset operation. The "output" return +// DescribeCampaignRequest generates a "aws/request.Request" representing the +// client's request for the DescribeCampaign operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeCampaign for more information on using the DescribeCampaign +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeCampaignRequest method. +// req, resp := client.DescribeCampaignRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign +func (c *Personalize) DescribeCampaignRequest(input *DescribeCampaignInput) (req *request.Request, output *DescribeCampaignOutput) { + op := &request.Operation{ + Name: opDescribeCampaign, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeCampaignInput{} + } + + output = &DescribeCampaignOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeCampaign API operation for Amazon Personalize. +// +// Describes the given campaign, including its status. +// +// A campaign can be in one of the following states: +// +// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// +// * DELETE PENDING > DELETE IN_PROGRESS +// +// When the status is CREATE FAILED, the response includes the failureReason +// key, which describes why. +// +// For more information on campaigns, see CreateCampaign. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation DescribeCampaign for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeCampaign +func (c *Personalize) DescribeCampaign(input *DescribeCampaignInput) (*DescribeCampaignOutput, error) { + req, out := c.DescribeCampaignRequest(input) + return out, req.Send() +} + +// DescribeCampaignWithContext is the same as DescribeCampaign with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeCampaign for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) DescribeCampaignWithContext(ctx aws.Context, input *DescribeCampaignInput, opts ...request.Option) (*DescribeCampaignOutput, error) { + req, out := c.DescribeCampaignRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDataset = "DescribeDataset" + +// DescribeDatasetRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDataset operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // @@ -2846,6 +3232,99 @@ func (c *Personalize) DescribeRecipeWithContext(ctx aws.Context, input *Describe return out, req.Send() } +const opDescribeRecommender = "DescribeRecommender" + +// DescribeRecommenderRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRecommender operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeRecommender for more information on using the DescribeRecommender +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeRecommenderRequest method. +// req, resp := client.DescribeRecommenderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommender +func (c *Personalize) DescribeRecommenderRequest(input *DescribeRecommenderInput) (req *request.Request, output *DescribeRecommenderOutput) { + op := &request.Operation{ + Name: opDescribeRecommender, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeRecommenderInput{} + } + + output = &DescribeRecommenderOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeRecommender API operation for Amazon Personalize. +// +// Describes the given recommender, including its status. +// +// A recommender can be in one of the following states: +// +// * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED +// +// * DELETE PENDING > DELETE IN_PROGRESS +// +// When the status is CREATE FAILED, the response includes the failureReason +// key, which describes why. +// +// For more information on recommenders, see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation DescribeRecommender for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeRecommender +func (c *Personalize) DescribeRecommender(input *DescribeRecommenderInput) (*DescribeRecommenderOutput, error) { + req, out := c.DescribeRecommenderRequest(input) + return out, req.Send() +} + +// DescribeRecommenderWithContext is the same as DescribeRecommender with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeRecommender for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) DescribeRecommenderWithContext(ctx aws.Context, input *DescribeRecommenderInput, opts ...request.Option) (*DescribeRecommenderOutput, error) { + req, out := c.DescribeRecommenderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeSchema = "DescribeSchema" // DescribeSchemaRequest generates a "aws/request.Request" representing the @@ -3319,35 +3798,35 @@ func (c *Personalize) ListBatchInferenceJobsPagesWithContext(ctx aws.Context, in return p.Err() } -const opListCampaigns = "ListCampaigns" +const opListBatchSegmentJobs = "ListBatchSegmentJobs" -// ListCampaignsRequest generates a "aws/request.Request" representing the -// client's request for the ListCampaigns operation. The "output" return +// ListBatchSegmentJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListBatchSegmentJobs operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListCampaigns for more information on using the ListCampaigns +// See ListBatchSegmentJobs for more information on using the ListBatchSegmentJobs // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListCampaignsRequest method. -// req, resp := client.ListCampaignsRequest(params) +// // Example sending a request using the ListBatchSegmentJobsRequest method. +// req, resp := client.ListBatchSegmentJobsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns -func (c *Personalize) ListCampaignsRequest(input *ListCampaignsInput) (req *request.Request, output *ListCampaignsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs +func (c *Personalize) ListBatchSegmentJobsRequest(input *ListBatchSegmentJobsInput) (req *request.Request, output *ListBatchSegmentJobsOutput) { op := &request.Operation{ - Name: opListCampaigns, + Name: opListBatchSegmentJobs, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -3359,27 +3838,25 @@ func (c *Personalize) ListCampaignsRequest(input *ListCampaignsInput) (req *requ } if input == nil { - input = &ListCampaignsInput{} + input = &ListBatchSegmentJobsInput{} } - output = &ListCampaignsOutput{} + output = &ListBatchSegmentJobsOutput{} req = c.newRequest(op, input, output) return } -// ListCampaigns API operation for Amazon Personalize. +// ListBatchSegmentJobs API operation for Amazon Personalize. // -// Returns a list of campaigns that use the given solution. When a solution -// is not specified, all the campaigns associated with the account are listed. -// The response provides the properties for each campaign, including the Amazon -// Resource Name (ARN). For more information on campaigns, see CreateCampaign. +// Gets a list of the batch segment jobs that have been performed off of a solution +// version that you specify. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Personalize's -// API operation ListCampaigns for usage and error information. +// API operation ListBatchSegmentJobs for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -3388,65 +3865,65 @@ func (c *Personalize) ListCampaignsRequest(input *ListCampaignsInput) (req *requ // * InvalidNextTokenException // The token is not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns -func (c *Personalize) ListCampaigns(input *ListCampaignsInput) (*ListCampaignsOutput, error) { - req, out := c.ListCampaignsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchSegmentJobs +func (c *Personalize) ListBatchSegmentJobs(input *ListBatchSegmentJobsInput) (*ListBatchSegmentJobsOutput, error) { + req, out := c.ListBatchSegmentJobsRequest(input) return out, req.Send() } -// ListCampaignsWithContext is the same as ListCampaigns with the addition of +// ListBatchSegmentJobsWithContext is the same as ListBatchSegmentJobs with the addition of // the ability to pass a context and additional request options. // -// See ListCampaigns for details on how to use this API operation. +// See ListBatchSegmentJobs for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) ListCampaignsWithContext(ctx aws.Context, input *ListCampaignsInput, opts ...request.Option) (*ListCampaignsOutput, error) { - req, out := c.ListCampaignsRequest(input) +func (c *Personalize) ListBatchSegmentJobsWithContext(ctx aws.Context, input *ListBatchSegmentJobsInput, opts ...request.Option) (*ListBatchSegmentJobsOutput, error) { + req, out := c.ListBatchSegmentJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListCampaignsPages iterates over the pages of a ListCampaigns operation, +// ListBatchSegmentJobsPages iterates over the pages of a ListBatchSegmentJobs operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListCampaigns method for more information on how to use this operation. +// See ListBatchSegmentJobs method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListCampaigns operation. +// // Example iterating over at most 3 pages of a ListBatchSegmentJobs operation. // pageNum := 0 -// err := client.ListCampaignsPages(params, -// func(page *personalize.ListCampaignsOutput, lastPage bool) bool { +// err := client.ListBatchSegmentJobsPages(params, +// func(page *personalize.ListBatchSegmentJobsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *Personalize) ListCampaignsPages(input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool) error { - return c.ListCampaignsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *Personalize) ListBatchSegmentJobsPages(input *ListBatchSegmentJobsInput, fn func(*ListBatchSegmentJobsOutput, bool) bool) error { + return c.ListBatchSegmentJobsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListCampaignsPagesWithContext same as ListCampaignsPages except +// ListBatchSegmentJobsPagesWithContext same as ListBatchSegmentJobsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) ListCampaignsPagesWithContext(ctx aws.Context, input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool, opts ...request.Option) error { +func (c *Personalize) ListBatchSegmentJobsPagesWithContext(ctx aws.Context, input *ListBatchSegmentJobsInput, fn func(*ListBatchSegmentJobsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListCampaignsInput + var inCpy *ListBatchSegmentJobsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListCampaignsRequest(inCpy) + req, _ := c.ListBatchSegmentJobsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -3454,7 +3931,7 @@ func (c *Personalize) ListCampaignsPagesWithContext(ctx aws.Context, input *List } for p.Next() { - if !fn(p.Page().(*ListCampaignsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListBatchSegmentJobsOutput), !p.HasNextPage()) { break } } @@ -3462,35 +3939,35 @@ func (c *Personalize) ListCampaignsPagesWithContext(ctx aws.Context, input *List return p.Err() } -const opListDatasetExportJobs = "ListDatasetExportJobs" +const opListCampaigns = "ListCampaigns" -// ListDatasetExportJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListDatasetExportJobs operation. The "output" return +// ListCampaignsRequest generates a "aws/request.Request" representing the +// client's request for the ListCampaigns operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListDatasetExportJobs for more information on using the ListDatasetExportJobs +// See ListCampaigns for more information on using the ListCampaigns // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListDatasetExportJobsRequest method. -// req, resp := client.ListDatasetExportJobsRequest(params) +// // Example sending a request using the ListCampaignsRequest method. +// req, resp := client.ListCampaignsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs -func (c *Personalize) ListDatasetExportJobsRequest(input *ListDatasetExportJobsInput) (req *request.Request, output *ListDatasetExportJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns +func (c *Personalize) ListCampaignsRequest(input *ListCampaignsInput) (req *request.Request, output *ListCampaignsOutput) { op := &request.Operation{ - Name: opListDatasetExportJobs, + Name: opListCampaigns, HTTPMethod: "POST", HTTPPath: "/", Paginator: &request.Paginator{ @@ -3502,29 +3979,27 @@ func (c *Personalize) ListDatasetExportJobsRequest(input *ListDatasetExportJobsI } if input == nil { - input = &ListDatasetExportJobsInput{} + input = &ListCampaignsInput{} } - output = &ListDatasetExportJobsOutput{} + output = &ListCampaignsOutput{} req = c.newRequest(op, input, output) return } -// ListDatasetExportJobs API operation for Amazon Personalize. +// ListCampaigns API operation for Amazon Personalize. // -// Returns a list of dataset export jobs that use the given dataset. When a -// dataset is not specified, all the dataset export jobs associated with the -// account are listed. The response provides the properties for each dataset -// export job, including the Amazon Resource Name (ARN). For more information -// on dataset export jobs, see CreateDatasetExportJob. For more information -// on datasets, see CreateDataset. +// Returns a list of campaigns that use the given solution. When a solution +// is not specified, all the campaigns associated with the account are listed. +// The response provides the properties for each campaign, including the Amazon +// Resource Name (ARN). For more information on campaigns, see CreateCampaign. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Personalize's -// API operation ListDatasetExportJobs for usage and error information. +// API operation ListCampaigns for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -3533,37 +4008,182 @@ func (c *Personalize) ListDatasetExportJobsRequest(input *ListDatasetExportJobsI // * InvalidNextTokenException // The token is not valid. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs -func (c *Personalize) ListDatasetExportJobs(input *ListDatasetExportJobsInput) (*ListDatasetExportJobsOutput, error) { - req, out := c.ListDatasetExportJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListCampaigns +func (c *Personalize) ListCampaigns(input *ListCampaignsInput) (*ListCampaignsOutput, error) { + req, out := c.ListCampaignsRequest(input) return out, req.Send() } -// ListDatasetExportJobsWithContext is the same as ListDatasetExportJobs with the addition of +// ListCampaignsWithContext is the same as ListCampaigns with the addition of // the ability to pass a context and additional request options. // -// See ListDatasetExportJobs for details on how to use this API operation. +// See ListCampaigns for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *Personalize) ListDatasetExportJobsWithContext(ctx aws.Context, input *ListDatasetExportJobsInput, opts ...request.Option) (*ListDatasetExportJobsOutput, error) { - req, out := c.ListDatasetExportJobsRequest(input) +func (c *Personalize) ListCampaignsWithContext(ctx aws.Context, input *ListCampaignsInput, opts ...request.Option) (*ListCampaignsOutput, error) { + req, out := c.ListCampaignsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDatasetExportJobsPages iterates over the pages of a ListDatasetExportJobs operation, +// ListCampaignsPages iterates over the pages of a ListCampaigns operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListDatasetExportJobs method for more information on how to use this operation. +// See ListCampaigns method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListDatasetExportJobs operation. +// // Example iterating over at most 3 pages of a ListCampaigns operation. +// pageNum := 0 +// err := client.ListCampaignsPages(params, +// func(page *personalize.ListCampaignsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Personalize) ListCampaignsPages(input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool) error { + return c.ListCampaignsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListCampaignsPagesWithContext same as ListCampaignsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListCampaignsPagesWithContext(ctx aws.Context, input *ListCampaignsInput, fn func(*ListCampaignsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListCampaignsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListCampaignsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListCampaignsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDatasetExportJobs = "ListDatasetExportJobs" + +// ListDatasetExportJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListDatasetExportJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListDatasetExportJobs for more information on using the ListDatasetExportJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListDatasetExportJobsRequest method. +// req, resp := client.ListDatasetExportJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs +func (c *Personalize) ListDatasetExportJobsRequest(input *ListDatasetExportJobsInput) (req *request.Request, output *ListDatasetExportJobsOutput) { + op := &request.Operation{ + Name: opListDatasetExportJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDatasetExportJobsInput{} + } + + output = &ListDatasetExportJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDatasetExportJobs API operation for Amazon Personalize. +// +// Returns a list of dataset export jobs that use the given dataset. When a +// dataset is not specified, all the dataset export jobs associated with the +// account are listed. The response provides the properties for each dataset +// export job, including the Amazon Resource Name (ARN). For more information +// on dataset export jobs, see CreateDatasetExportJob. For more information +// on datasets, see CreateDataset. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation ListDatasetExportJobs for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * InvalidNextTokenException +// The token is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListDatasetExportJobs +func (c *Personalize) ListDatasetExportJobs(input *ListDatasetExportJobsInput) (*ListDatasetExportJobsOutput, error) { + req, out := c.ListDatasetExportJobsRequest(input) + return out, req.Send() +} + +// ListDatasetExportJobsWithContext is the same as ListDatasetExportJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListDatasetExportJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListDatasetExportJobsWithContext(ctx aws.Context, input *ListDatasetExportJobsInput, opts ...request.Option) (*ListDatasetExportJobsOutput, error) { + req, out := c.ListDatasetExportJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDatasetExportJobsPages iterates over the pages of a ListDatasetExportJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDatasetExportJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListDatasetExportJobs operation. // pageNum := 0 // err := client.ListDatasetExportJobsPages(params, // func(page *personalize.ListDatasetExportJobsOutput, lastPage bool) bool { @@ -4379,6 +4999,9 @@ func (c *Personalize) ListRecipesRequest(input *ListRecipesInput) (req *request. // * InvalidNextTokenException // The token is not valid. // +// * InvalidInputException +// Provide a valid value for the field or parameter. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecipes func (c *Personalize) ListRecipes(input *ListRecipesInput) (*ListRecipesOutput, error) { req, out := c.ListRecipesRequest(input) @@ -4453,6 +5076,150 @@ func (c *Personalize) ListRecipesPagesWithContext(ctx aws.Context, input *ListRe return p.Err() } +const opListRecommenders = "ListRecommenders" + +// ListRecommendersRequest generates a "aws/request.Request" representing the +// client's request for the ListRecommenders operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListRecommenders for more information on using the ListRecommenders +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListRecommendersRequest method. +// req, resp := client.ListRecommendersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders +func (c *Personalize) ListRecommendersRequest(input *ListRecommendersInput) (req *request.Request, output *ListRecommendersOutput) { + op := &request.Operation{ + Name: opListRecommenders, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListRecommendersInput{} + } + + output = &ListRecommendersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListRecommenders API operation for Amazon Personalize. +// +// Returns a list of recommenders in a given Domain dataset group. When a Domain +// dataset group is not specified, all the recommenders associated with the +// account are listed. The response provides the properties for each recommender, +// including the Amazon Resource Name (ARN). For more information on recommenders, +// see CreateRecommender (https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation ListRecommenders for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * InvalidNextTokenException +// The token is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListRecommenders +func (c *Personalize) ListRecommenders(input *ListRecommendersInput) (*ListRecommendersOutput, error) { + req, out := c.ListRecommendersRequest(input) + return out, req.Send() +} + +// ListRecommendersWithContext is the same as ListRecommenders with the addition of +// the ability to pass a context and additional request options. +// +// See ListRecommenders for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListRecommendersWithContext(ctx aws.Context, input *ListRecommendersInput, opts ...request.Option) (*ListRecommendersOutput, error) { + req, out := c.ListRecommendersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListRecommendersPages iterates over the pages of a ListRecommenders operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRecommenders method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListRecommenders operation. +// pageNum := 0 +// err := client.ListRecommendersPages(params, +// func(page *personalize.ListRecommendersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Personalize) ListRecommendersPages(input *ListRecommendersInput, fn func(*ListRecommendersOutput, bool) bool) error { + return c.ListRecommendersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListRecommendersPagesWithContext same as ListRecommendersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) ListRecommendersPagesWithContext(ctx aws.Context, input *ListRecommendersInput, fn func(*ListRecommendersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRecommendersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRecommendersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRecommendersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListSchemas = "ListSchemas" // ListSchemasRequest generates a "aws/request.Request" representing the @@ -5073,6 +5840,91 @@ func (c *Personalize) UpdateCampaignWithContext(ctx aws.Context, input *UpdateCa return out, req.Send() } +const opUpdateRecommender = "UpdateRecommender" + +// UpdateRecommenderRequest generates a "aws/request.Request" representing the +// client's request for the UpdateRecommender operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateRecommender for more information on using the UpdateRecommender +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateRecommenderRequest method. +// req, resp := client.UpdateRecommenderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommender +func (c *Personalize) UpdateRecommenderRequest(input *UpdateRecommenderInput) (req *request.Request, output *UpdateRecommenderOutput) { + op := &request.Operation{ + Name: opUpdateRecommender, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateRecommenderInput{} + } + + output = &UpdateRecommenderOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateRecommender API operation for Amazon Personalize. +// +// Updates the recommender to modify the recommender configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Personalize's +// API operation UpdateRecommender for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// Provide a valid value for the field or parameter. +// +// * ResourceNotFoundException +// Could not find the specified resource. +// +// * ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateRecommender +func (c *Personalize) UpdateRecommender(input *UpdateRecommenderInput) (*UpdateRecommenderOutput, error) { + req, out := c.UpdateRecommenderRequest(input) + return out, req.Send() +} + +// UpdateRecommenderWithContext is the same as UpdateRecommender with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateRecommender for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Personalize) UpdateRecommenderWithContext(ctx aws.Context, input *UpdateRecommenderInput, opts ...request.Option) (*UpdateRecommenderOutput, error) { + req, out := c.UpdateRecommenderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // Describes a custom algorithm. type Algorithm struct { _ struct{} `type:"structure"` @@ -5700,47 +6552,57 @@ func (s *BatchInferenceJobSummary) SetStatus(v string) *BatchInferenceJobSummary return s } -// Describes a deployed solution version, otherwise known as a campaign. For -// more information on campaigns, see CreateCampaign. -type Campaign struct { +// Contains information on a batch segment job. +type BatchSegmentJob struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the campaign. - CampaignArn *string `locationName:"campaignArn" type:"string"` - - // The configuration details of a campaign. - CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"` + // The Amazon Resource Name (ARN) of the batch segment job. + BatchSegmentJobArn *string `locationName:"batchSegmentJobArn" type:"string"` - // The date and time (in Unix format) that the campaign was created. + // The time at which the batch segment job was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` - // If a campaign fails, the reason behind the failure. + // If the batch segment job failed, the reason for the failure. FailureReason *string `locationName:"failureReason" type:"string"` - // The date and time (in Unix format) that the campaign was last updated. - LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + // The ARN of the filter used on the batch segment job. + FilterArn *string `locationName:"filterArn" type:"string"` - // Provides a summary of the properties of a campaign update. For a complete - // listing, call the DescribeCampaign API. - LatestCampaignUpdate *CampaignUpdateSummary `locationName:"latestCampaignUpdate" type:"structure"` + // The Amazon S3 path that leads to the input data used to generate the batch + // segment job. + JobInput *BatchSegmentJobInput_ `locationName:"jobInput" type:"structure"` - // Specifies the requested minimum provisioned transactions (recommendations) - // per second. - MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"` + // The name of the batch segment job. + JobName *string `locationName:"jobName" min:"1" type:"string"` - // The name of the campaign. - Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon S3 bucket that contains the output data generated by the batch + // segment job. + JobOutput *BatchSegmentJobOutput_ `locationName:"jobOutput" type:"structure"` - // The Amazon Resource Name (ARN) of a specific version of the solution. + // The time at which the batch segment job last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The number of predicted users generated by the batch segment job for each + // line of input data. + NumResults *int64 `locationName:"numResults" type:"integer"` + + // The ARN of the Amazon Identity and Access Management (IAM) role that requested + // the batch segment job. + RoleArn *string `locationName:"roleArn" type:"string"` + + // The Amazon Resource Name (ARN) of the solution version used by the batch + // segment job to generate batch segments. SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"` - // The status of the campaign. + // The status of the batch segment job. The status is one of the following values: // - // A campaign can be in one of the following states: + // * PENDING // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // * IN PROGRESS // - // * DELETE PENDING > DELETE IN_PROGRESS + // * ACTIVE + // + // * CREATE FAILED Status *string `locationName:"status" type:"string"` } @@ -5749,7 +6611,7 @@ type Campaign struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Campaign) String() string { +func (s BatchSegmentJob) String() string { return awsutil.Prettify(s) } @@ -5758,81 +6620,90 @@ func (s Campaign) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Campaign) GoString() string { +func (s BatchSegmentJob) GoString() string { return s.String() } -// SetCampaignArn sets the CampaignArn field's value. -func (s *Campaign) SetCampaignArn(v string) *Campaign { - s.CampaignArn = &v - return s -} - -// SetCampaignConfig sets the CampaignConfig field's value. -func (s *Campaign) SetCampaignConfig(v *CampaignConfig) *Campaign { - s.CampaignConfig = v +// SetBatchSegmentJobArn sets the BatchSegmentJobArn field's value. +func (s *BatchSegmentJob) SetBatchSegmentJobArn(v string) *BatchSegmentJob { + s.BatchSegmentJobArn = &v return s } // SetCreationDateTime sets the CreationDateTime field's value. -func (s *Campaign) SetCreationDateTime(v time.Time) *Campaign { +func (s *BatchSegmentJob) SetCreationDateTime(v time.Time) *BatchSegmentJob { s.CreationDateTime = &v return s } // SetFailureReason sets the FailureReason field's value. -func (s *Campaign) SetFailureReason(v string) *Campaign { +func (s *BatchSegmentJob) SetFailureReason(v string) *BatchSegmentJob { s.FailureReason = &v return s } -// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. -func (s *Campaign) SetLastUpdatedDateTime(v time.Time) *Campaign { - s.LastUpdatedDateTime = &v +// SetFilterArn sets the FilterArn field's value. +func (s *BatchSegmentJob) SetFilterArn(v string) *BatchSegmentJob { + s.FilterArn = &v return s } -// SetLatestCampaignUpdate sets the LatestCampaignUpdate field's value. -func (s *Campaign) SetLatestCampaignUpdate(v *CampaignUpdateSummary) *Campaign { - s.LatestCampaignUpdate = v +// SetJobInput sets the JobInput field's value. +func (s *BatchSegmentJob) SetJobInput(v *BatchSegmentJobInput_) *BatchSegmentJob { + s.JobInput = v return s } -// SetMinProvisionedTPS sets the MinProvisionedTPS field's value. -func (s *Campaign) SetMinProvisionedTPS(v int64) *Campaign { - s.MinProvisionedTPS = &v +// SetJobName sets the JobName field's value. +func (s *BatchSegmentJob) SetJobName(v string) *BatchSegmentJob { + s.JobName = &v return s } -// SetName sets the Name field's value. -func (s *Campaign) SetName(v string) *Campaign { - s.Name = &v +// SetJobOutput sets the JobOutput field's value. +func (s *BatchSegmentJob) SetJobOutput(v *BatchSegmentJobOutput_) *BatchSegmentJob { + s.JobOutput = v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *BatchSegmentJob) SetLastUpdatedDateTime(v time.Time) *BatchSegmentJob { + s.LastUpdatedDateTime = &v + return s +} + +// SetNumResults sets the NumResults field's value. +func (s *BatchSegmentJob) SetNumResults(v int64) *BatchSegmentJob { + s.NumResults = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *BatchSegmentJob) SetRoleArn(v string) *BatchSegmentJob { + s.RoleArn = &v return s } // SetSolutionVersionArn sets the SolutionVersionArn field's value. -func (s *Campaign) SetSolutionVersionArn(v string) *Campaign { +func (s *BatchSegmentJob) SetSolutionVersionArn(v string) *BatchSegmentJob { s.SolutionVersionArn = &v return s } // SetStatus sets the Status field's value. -func (s *Campaign) SetStatus(v string) *Campaign { +func (s *BatchSegmentJob) SetStatus(v string) *BatchSegmentJob { s.Status = &v return s } -// The configuration details of a campaign. -type CampaignConfig struct { +// The input configuration of a batch segment job. +type BatchSegmentJobInput_ struct { _ struct{} `type:"structure"` - // A string to string map specifying the exploration configuration hyperparameters, - // including explorationWeight and explorationItemAgeCutOff, you want to use - // to configure the amount of item exploration Amazon Personalize uses when - // recommending items. Provide itemExplorationConfig data only if your solution - // uses the User-Personalization (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) - // recipe. - ItemExplorationConfig map[string]*string `locationName:"itemExplorationConfig" type:"map"` + // The configuration details of an Amazon S3 input or output bucket. + // + // S3DataSource is a required field + S3DataSource *S3DataConfig `locationName:"s3DataSource" type:"structure" required:"true"` } // String returns the string representation. @@ -5840,7 +6711,7 @@ type CampaignConfig struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CampaignConfig) String() string { +func (s BatchSegmentJobInput_) String() string { return awsutil.Prettify(s) } @@ -5849,43 +6720,119 @@ func (s CampaignConfig) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CampaignConfig) GoString() string { +func (s BatchSegmentJobInput_) GoString() string { return s.String() } -// SetItemExplorationConfig sets the ItemExplorationConfig field's value. -func (s *CampaignConfig) SetItemExplorationConfig(v map[string]*string) *CampaignConfig { - s.ItemExplorationConfig = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchSegmentJobInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchSegmentJobInput_"} + if s.S3DataSource == nil { + invalidParams.Add(request.NewErrParamRequired("S3DataSource")) + } + if s.S3DataSource != nil { + if err := s.S3DataSource.Validate(); err != nil { + invalidParams.AddNested("S3DataSource", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3DataSource sets the S3DataSource field's value. +func (s *BatchSegmentJobInput_) SetS3DataSource(v *S3DataConfig) *BatchSegmentJobInput_ { + s.S3DataSource = v return s } -// Provides a summary of the properties of a campaign. For a complete listing, -// call the DescribeCampaign API. -type CampaignSummary struct { +// The output configuration parameters of a batch segment job. +type BatchSegmentJobOutput_ struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the campaign. - CampaignArn *string `locationName:"campaignArn" type:"string"` + // The configuration details of an Amazon S3 input or output bucket. + // + // S3DataDestination is a required field + S3DataDestination *S3DataConfig `locationName:"s3DataDestination" type:"structure" required:"true"` +} - // The date and time (in Unix time) that the campaign was created. +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchSegmentJobOutput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BatchSegmentJobOutput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchSegmentJobOutput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchSegmentJobOutput_"} + if s.S3DataDestination == nil { + invalidParams.Add(request.NewErrParamRequired("S3DataDestination")) + } + if s.S3DataDestination != nil { + if err := s.S3DataDestination.Validate(); err != nil { + invalidParams.AddNested("S3DataDestination", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3DataDestination sets the S3DataDestination field's value. +func (s *BatchSegmentJobOutput_) SetS3DataDestination(v *S3DataConfig) *BatchSegmentJobOutput_ { + s.S3DataDestination = v + return s +} + +// A truncated version of the BatchSegmentJob datatype. The ListBatchSegmentJobs +// operation returns a list of batch segment job summaries. +type BatchSegmentJobSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the batch segment job. + BatchSegmentJobArn *string `locationName:"batchSegmentJobArn" type:"string"` + + // The time at which the batch segment job was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` - // If a campaign fails, the reason behind the failure. + // If the batch segment job failed, the reason for the failure. FailureReason *string `locationName:"failureReason" type:"string"` - // The date and time (in Unix time) that the campaign was last updated. + // The name of the batch segment job. + JobName *string `locationName:"jobName" min:"1" type:"string"` + + // The time at which the batch segment job was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` - // The name of the campaign. - Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the solution version used by the batch + // segment job to generate batch segments. + SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"` - // The status of the campaign. + // The status of the batch segment job. The status is one of the following values: // - // A campaign can be in one of the following states: + // * PENDING // - // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // * IN PROGRESS // - // * DELETE PENDING > DELETE IN_PROGRESS + // * ACTIVE + // + // * CREATE FAILED Status *string `locationName:"status" type:"string"` } @@ -5894,7 +6841,7 @@ type CampaignSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CampaignSummary) String() string { +func (s BatchSegmentJobSummary) String() string { return awsutil.Prettify(s) } @@ -5903,7 +6850,256 @@ func (s CampaignSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CampaignSummary) GoString() string { +func (s BatchSegmentJobSummary) GoString() string { + return s.String() +} + +// SetBatchSegmentJobArn sets the BatchSegmentJobArn field's value. +func (s *BatchSegmentJobSummary) SetBatchSegmentJobArn(v string) *BatchSegmentJobSummary { + s.BatchSegmentJobArn = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *BatchSegmentJobSummary) SetCreationDateTime(v time.Time) *BatchSegmentJobSummary { + s.CreationDateTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *BatchSegmentJobSummary) SetFailureReason(v string) *BatchSegmentJobSummary { + s.FailureReason = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *BatchSegmentJobSummary) SetJobName(v string) *BatchSegmentJobSummary { + s.JobName = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *BatchSegmentJobSummary) SetLastUpdatedDateTime(v time.Time) *BatchSegmentJobSummary { + s.LastUpdatedDateTime = &v + return s +} + +// SetSolutionVersionArn sets the SolutionVersionArn field's value. +func (s *BatchSegmentJobSummary) SetSolutionVersionArn(v string) *BatchSegmentJobSummary { + s.SolutionVersionArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *BatchSegmentJobSummary) SetStatus(v string) *BatchSegmentJobSummary { + s.Status = &v + return s +} + +// An object that describes the deployment of a solution version. For more information +// on campaigns, see CreateCampaign. +type Campaign struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the campaign. + CampaignArn *string `locationName:"campaignArn" type:"string"` + + // The configuration details of a campaign. + CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"` + + // The date and time (in Unix format) that the campaign was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // If a campaign fails, the reason behind the failure. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The date and time (in Unix format) that the campaign was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // Provides a summary of the properties of a campaign update. For a complete + // listing, call the DescribeCampaign API. + LatestCampaignUpdate *CampaignUpdateSummary `locationName:"latestCampaignUpdate" type:"structure"` + + // Specifies the requested minimum provisioned transactions (recommendations) + // per second. + MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"` + + // The name of the campaign. + Name *string `locationName:"name" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of a specific version of the solution. + SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"` + + // The status of the campaign. + // + // A campaign can be in one of the following states: + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // + // * DELETE PENDING > DELETE IN_PROGRESS + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Campaign) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Campaign) GoString() string { + return s.String() +} + +// SetCampaignArn sets the CampaignArn field's value. +func (s *Campaign) SetCampaignArn(v string) *Campaign { + s.CampaignArn = &v + return s +} + +// SetCampaignConfig sets the CampaignConfig field's value. +func (s *Campaign) SetCampaignConfig(v *CampaignConfig) *Campaign { + s.CampaignConfig = v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *Campaign) SetCreationDateTime(v time.Time) *Campaign { + s.CreationDateTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *Campaign) SetFailureReason(v string) *Campaign { + s.FailureReason = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *Campaign) SetLastUpdatedDateTime(v time.Time) *Campaign { + s.LastUpdatedDateTime = &v + return s +} + +// SetLatestCampaignUpdate sets the LatestCampaignUpdate field's value. +func (s *Campaign) SetLatestCampaignUpdate(v *CampaignUpdateSummary) *Campaign { + s.LatestCampaignUpdate = v + return s +} + +// SetMinProvisionedTPS sets the MinProvisionedTPS field's value. +func (s *Campaign) SetMinProvisionedTPS(v int64) *Campaign { + s.MinProvisionedTPS = &v + return s +} + +// SetName sets the Name field's value. +func (s *Campaign) SetName(v string) *Campaign { + s.Name = &v + return s +} + +// SetSolutionVersionArn sets the SolutionVersionArn field's value. +func (s *Campaign) SetSolutionVersionArn(v string) *Campaign { + s.SolutionVersionArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *Campaign) SetStatus(v string) *Campaign { + s.Status = &v + return s +} + +// The configuration details of a campaign. +type CampaignConfig struct { + _ struct{} `type:"structure"` + + // Specifies the exploration configuration hyperparameters, including explorationWeight + // and explorationItemAgeCutOff, you want to use to configure the amount of + // item exploration Amazon Personalize uses when recommending items. Provide + // itemExplorationConfig data only if your solution uses the User-Personalization + // (https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html) + // recipe. + ItemExplorationConfig map[string]*string `locationName:"itemExplorationConfig" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignConfig) GoString() string { + return s.String() +} + +// SetItemExplorationConfig sets the ItemExplorationConfig field's value. +func (s *CampaignConfig) SetItemExplorationConfig(v map[string]*string) *CampaignConfig { + s.ItemExplorationConfig = v + return s +} + +// Provides a summary of the properties of a campaign. For a complete listing, +// call the DescribeCampaign API. +type CampaignSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the campaign. + CampaignArn *string `locationName:"campaignArn" type:"string"` + + // The date and time (in Unix time) that the campaign was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // If a campaign fails, the reason behind the failure. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The date and time (in Unix time) that the campaign was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The name of the campaign. + Name *string `locationName:"name" min:"1" type:"string"` + + // The status of the campaign. + // + // A campaign can be in one of the following states: + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // + // * DELETE PENDING > DELETE IN_PROGRESS + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CampaignSummary) GoString() string { return s.String() } @@ -6321,30 +7517,199 @@ func (s *CreateBatchInferenceJobOutput) SetBatchInferenceJobArn(v string) *Creat return s } -type CreateCampaignInput struct { +type CreateBatchSegmentJobInput struct { _ struct{} `type:"structure"` - // The configuration details of a campaign. - CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"` + // The ARN of the filter to apply to the batch segment job. For more information + // on using filters, see filter-batch. + FilterArn *string `locationName:"filterArn" type:"string"` - // Specifies the requested minimum provisioned transactions (recommendations) - // per second that Amazon Personalize will support. - MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"` + // The Amazon S3 path for the input data used to generate the batch segment + // job. + // + // JobInput is a required field + JobInput *BatchSegmentJobInput_ `locationName:"jobInput" type:"structure" required:"true"` - // A name for the new campaign. The campaign name must be unique within your - // account. + // The name of the batch segment job to create. // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` + // JobName is a required field + JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the solution version to deploy. + // The Amazon S3 path for the bucket where the job's output will be stored. // - // SolutionVersionArn is a required field - SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"` -} + // JobOutput is a required field + JobOutput *BatchSegmentJobOutput_ `locationName:"jobOutput" type:"structure" required:"true"` -// String returns the string representation. -// + // The number of predicted users generated by the batch segment job for each + // line of input data. + NumResults *int64 `locationName:"numResults" type:"integer"` + + // The ARN of the Amazon Identity and Access Management role that has permissions + // to read and write to your input and output Amazon S3 buckets respectively. + // + // RoleArn is a required field + RoleArn *string `locationName:"roleArn" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the solution version you want the batch + // segment job to use to generate batch segments. + // + // SolutionVersionArn is a required field + SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateBatchSegmentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateBatchSegmentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateBatchSegmentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateBatchSegmentJobInput"} + if s.JobInput == nil { + invalidParams.Add(request.NewErrParamRequired("JobInput")) + } + if s.JobName == nil { + invalidParams.Add(request.NewErrParamRequired("JobName")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.JobOutput == nil { + invalidParams.Add(request.NewErrParamRequired("JobOutput")) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + if s.SolutionVersionArn == nil { + invalidParams.Add(request.NewErrParamRequired("SolutionVersionArn")) + } + if s.JobInput != nil { + if err := s.JobInput.Validate(); err != nil { + invalidParams.AddNested("JobInput", err.(request.ErrInvalidParams)) + } + } + if s.JobOutput != nil { + if err := s.JobOutput.Validate(); err != nil { + invalidParams.AddNested("JobOutput", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilterArn sets the FilterArn field's value. +func (s *CreateBatchSegmentJobInput) SetFilterArn(v string) *CreateBatchSegmentJobInput { + s.FilterArn = &v + return s +} + +// SetJobInput sets the JobInput field's value. +func (s *CreateBatchSegmentJobInput) SetJobInput(v *BatchSegmentJobInput_) *CreateBatchSegmentJobInput { + s.JobInput = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *CreateBatchSegmentJobInput) SetJobName(v string) *CreateBatchSegmentJobInput { + s.JobName = &v + return s +} + +// SetJobOutput sets the JobOutput field's value. +func (s *CreateBatchSegmentJobInput) SetJobOutput(v *BatchSegmentJobOutput_) *CreateBatchSegmentJobInput { + s.JobOutput = v + return s +} + +// SetNumResults sets the NumResults field's value. +func (s *CreateBatchSegmentJobInput) SetNumResults(v int64) *CreateBatchSegmentJobInput { + s.NumResults = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreateBatchSegmentJobInput) SetRoleArn(v string) *CreateBatchSegmentJobInput { + s.RoleArn = &v + return s +} + +// SetSolutionVersionArn sets the SolutionVersionArn field's value. +func (s *CreateBatchSegmentJobInput) SetSolutionVersionArn(v string) *CreateBatchSegmentJobInput { + s.SolutionVersionArn = &v + return s +} + +type CreateBatchSegmentJobOutput struct { + _ struct{} `type:"structure"` + + // The ARN of the batch segment job. + BatchSegmentJobArn *string `locationName:"batchSegmentJobArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateBatchSegmentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateBatchSegmentJobOutput) GoString() string { + return s.String() +} + +// SetBatchSegmentJobArn sets the BatchSegmentJobArn field's value. +func (s *CreateBatchSegmentJobOutput) SetBatchSegmentJobArn(v string) *CreateBatchSegmentJobOutput { + s.BatchSegmentJobArn = &v + return s +} + +type CreateCampaignInput struct { + _ struct{} `type:"structure"` + + // The configuration details of a campaign. + CampaignConfig *CampaignConfig `locationName:"campaignConfig" type:"structure"` + + // Specifies the requested minimum provisioned transactions (recommendations) + // per second that Amazon Personalize will support. + MinProvisionedTPS *int64 `locationName:"minProvisionedTPS" min:"1" type:"integer"` + + // A name for the new campaign. The campaign name must be unique within your + // account. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the solution version to deploy. + // + // SolutionVersionArn is a required field + SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string" required:"true"` +} + +// String returns the string representation. +// // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". @@ -6581,6 +7946,13 @@ func (s *CreateDatasetExportJobOutput) SetDatasetExportJobArn(v string) *CreateD type CreateDatasetGroupInput struct { _ struct{} `type:"structure"` + // The domain of the dataset group. Specify a domain to create a Domain dataset + // group. The domain you specify determines the default schemas for datasets + // and the use cases available for recommenders. If you don't specify a domain, + // you create a Custom dataset group with solution versions that you deploy + // with a campaign. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used // to encrypt the datasets. KmsKeyArn *string `locationName:"kmsKeyArn" type:"string"` @@ -6630,6 +8002,12 @@ func (s *CreateDatasetGroupInput) Validate() error { return nil } +// SetDomain sets the Domain field's value. +func (s *CreateDatasetGroupInput) SetDomain(v string) *CreateDatasetGroupInput { + s.Domain = &v + return s +} + // SetKmsKeyArn sets the KmsKeyArn field's value. func (s *CreateDatasetGroupInput) SetKmsKeyArn(v string) *CreateDatasetGroupInput { s.KmsKeyArn = &v @@ -6653,6 +8031,9 @@ type CreateDatasetGroupOutput struct { // The Amazon Resource Name (ARN) of the new dataset group. DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The domain for the new Domain dataset group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` } // String returns the string representation. @@ -6679,6 +8060,12 @@ func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGr return s } +// SetDomain sets the Domain field's value. +func (s *CreateDatasetGroupOutput) SetDomain(v string) *CreateDatasetGroupOutput { + s.Domain = &v + return s +} + type CreateDatasetImportJobInput struct { _ struct{} `type:"structure"` @@ -7156,9 +8543,135 @@ func (s *CreateFilterOutput) SetFilterArn(v string) *CreateFilterOutput { return s } +type CreateRecommenderInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the destination domain dataset group for + // the recommender. + // + // DatasetGroupArn is a required field + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string" required:"true"` + + // The name of the recommender. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the recipe that the recommender will use. + // For a recommender, a recipe is a Domain dataset group use case. Only Domain + // dataset group use cases can be used to create a recommender. For information + // about use cases see Choosing recommender use cases (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). + // + // RecipeArn is a required field + RecipeArn *string `locationName:"recipeArn" type:"string" required:"true"` + + // The configuration details of the recommender. + RecommenderConfig *RecommenderConfig `locationName:"recommenderConfig" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommenderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommenderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRecommenderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRecommenderInput"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RecipeArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecipeArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *CreateRecommenderInput) SetDatasetGroupArn(v string) *CreateRecommenderInput { + s.DatasetGroupArn = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRecommenderInput) SetName(v string) *CreateRecommenderInput { + s.Name = &v + return s +} + +// SetRecipeArn sets the RecipeArn field's value. +func (s *CreateRecommenderInput) SetRecipeArn(v string) *CreateRecommenderInput { + s.RecipeArn = &v + return s +} + +// SetRecommenderConfig sets the RecommenderConfig field's value. +func (s *CreateRecommenderInput) SetRecommenderConfig(v *RecommenderConfig) *CreateRecommenderInput { + s.RecommenderConfig = v + return s +} + +type CreateRecommenderOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the recommender. + RecommenderArn *string `locationName:"recommenderArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommenderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRecommenderOutput) GoString() string { + return s.String() +} + +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *CreateRecommenderOutput) SetRecommenderArn(v string) *CreateRecommenderOutput { + s.RecommenderArn = &v + return s +} + type CreateSchemaInput struct { _ struct{} `type:"structure"` + // The domain for the schema. If you are creating a schema for a dataset in + // a Domain dataset group, specify the domain you chose when you created the + // Domain dataset group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // The name for the schema. // // Name is a required field @@ -7207,6 +8720,12 @@ func (s *CreateSchemaInput) Validate() error { return nil } +// SetDomain sets the Domain field's value. +func (s *CreateSchemaInput) SetDomain(v string) *CreateSchemaInput { + s.Domain = &v + return s +} + // SetName sets the Name field's value. func (s *CreateSchemaInput) SetName(v string) *CreateSchemaInput { s.Name = &v @@ -7937,6 +9456,9 @@ type DatasetGroup struct { // The Amazon Resource Name (ARN) of the dataset group. DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + // The domain of a Domain dataset group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // If creating a dataset group fails, provides the reason why. FailureReason *string `locationName:"failureReason" type:"string"` @@ -7993,6 +9515,12 @@ func (s *DatasetGroup) SetDatasetGroupArn(v string) *DatasetGroup { return s } +// SetDomain sets the Domain field's value. +func (s *DatasetGroup) SetDomain(v string) *DatasetGroup { + s.Domain = &v + return s +} + // SetFailureReason sets the FailureReason field's value. func (s *DatasetGroup) SetFailureReason(v string) *DatasetGroup { s.FailureReason = &v @@ -8040,6 +9568,9 @@ type DatasetGroupSummary struct { // The Amazon Resource Name (ARN) of the dataset group. DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + // The domain of a Domain dataset group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // If creating a dataset group fails, the reason behind the failure. FailureReason *string `locationName:"failureReason" type:"string"` @@ -8089,6 +9620,12 @@ func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary return s } +// SetDomain sets the Domain field's value. +func (s *DatasetGroupSummary) SetDomain(v string) *DatasetGroupSummary { + s.Domain = &v + return s +} + // SetFailureReason sets the FailureReason field's value. func (s *DatasetGroupSummary) SetFailureReason(v string) *DatasetGroupSummary { s.FailureReason = &v @@ -8319,6 +9856,10 @@ type DatasetSchema struct { // The date and time (in Unix time) that the schema was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + // The domain of a schema that you created for a dataset in a Domain dataset + // group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // The date and time (in Unix time) that the schema was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` @@ -8356,6 +9897,12 @@ func (s *DatasetSchema) SetCreationDateTime(v time.Time) *DatasetSchema { return s } +// SetDomain sets the Domain field's value. +func (s *DatasetSchema) SetDomain(v string) *DatasetSchema { + s.Domain = &v + return s +} + // SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. func (s *DatasetSchema) SetLastUpdatedDateTime(v time.Time) *DatasetSchema { s.LastUpdatedDateTime = &v @@ -8388,6 +9935,10 @@ type DatasetSchemaSummary struct { // The date and time (in Unix time) that the schema was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + // The domain of a schema that you created for a dataset in a Domain dataset + // group. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // The date and time (in Unix time) that the schema was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` @@ -8422,6 +9973,12 @@ func (s *DatasetSchemaSummary) SetCreationDateTime(v time.Time) *DatasetSchemaSu return s } +// SetDomain sets the Domain field's value. +func (s *DatasetSchemaSummary) SetDomain(v string) *DatasetSchemaSummary { + s.Domain = &v + return s +} + // SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. func (s *DatasetSchemaSummary) SetLastUpdatedDateTime(v time.Time) *DatasetSchemaSummary { s.LastUpdatedDateTime = &v @@ -9097,6 +10654,74 @@ func (s DeleteFilterOutput) GoString() string { return s.String() } +type DeleteRecommenderInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the recommender to delete. + // + // RecommenderArn is a required field + RecommenderArn *string `locationName:"recommenderArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommenderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommenderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRecommenderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRecommenderInput"} + if s.RecommenderArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecommenderArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *DeleteRecommenderInput) SetRecommenderArn(v string) *DeleteRecommenderInput { + s.RecommenderArn = &v + return s +} + +type DeleteRecommenderOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommenderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRecommenderOutput) GoString() string { + return s.String() +} + type DeleteSchemaInput struct { _ struct{} `type:"structure"` @@ -9387,6 +11012,83 @@ func (s *DescribeBatchInferenceJobOutput) SetBatchInferenceJob(v *BatchInference return s } +type DescribeBatchSegmentJobInput struct { + _ struct{} `type:"structure"` + + // The ARN of the batch segment job to describe. + // + // BatchSegmentJobArn is a required field + BatchSegmentJobArn *string `locationName:"batchSegmentJobArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeBatchSegmentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeBatchSegmentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeBatchSegmentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeBatchSegmentJobInput"} + if s.BatchSegmentJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("BatchSegmentJobArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatchSegmentJobArn sets the BatchSegmentJobArn field's value. +func (s *DescribeBatchSegmentJobInput) SetBatchSegmentJobArn(v string) *DescribeBatchSegmentJobInput { + s.BatchSegmentJobArn = &v + return s +} + +type DescribeBatchSegmentJobOutput struct { + _ struct{} `type:"structure"` + + // Information on the specified batch segment job. + BatchSegmentJob *BatchSegmentJob `locationName:"batchSegmentJob" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeBatchSegmentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeBatchSegmentJobOutput) GoString() string { + return s.String() +} + +// SetBatchSegmentJob sets the BatchSegmentJob field's value. +func (s *DescribeBatchSegmentJobOutput) SetBatchSegmentJob(v *BatchSegmentJob) *DescribeBatchSegmentJobOutput { + s.BatchSegmentJob = v + return s +} + type DescribeCampaignInput struct { _ struct{} `type:"structure"` @@ -10100,6 +11802,83 @@ func (s *DescribeRecipeOutput) SetRecipe(v *Recipe) *DescribeRecipeOutput { return s } +type DescribeRecommenderInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the recommender to describe. + // + // RecommenderArn is a required field + RecommenderArn *string `locationName:"recommenderArn" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRecommenderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRecommenderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeRecommenderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRecommenderInput"} + if s.RecommenderArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecommenderArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *DescribeRecommenderInput) SetRecommenderArn(v string) *DescribeRecommenderInput { + s.RecommenderArn = &v + return s +} + +type DescribeRecommenderOutput struct { + _ struct{} `type:"structure"` + + // The properties of the recommender. + Recommender *Recommender `locationName:"recommender" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRecommenderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeRecommenderOutput) GoString() string { + return s.String() +} + +// SetRecommender sets the Recommender field's value. +func (s *DescribeRecommenderOutput) SetRecommender(v *Recommender) *DescribeRecommenderOutput { + s.Recommender = v + return s +} + type DescribeSchemaInput struct { _ struct{} `type:"structure"` @@ -11469,20 +13248,19 @@ func (s *ListBatchInferenceJobsOutput) SetNextToken(v string) *ListBatchInferenc return s } -type ListCampaignsInput struct { +type ListBatchSegmentJobsInput struct { _ struct{} `type:"structure"` - // The maximum number of campaigns to return. + // The maximum number of batch segment job results to return in each page. The + // default value is 100. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // A token returned from the previous call to ListCampaigns for getting the - // next set of campaigns (if they exist). + // The token to request the next page of results. NextToken *string `locationName:"nextToken" type:"string"` - // The Amazon Resource Name (ARN) of the solution to list the campaigns for. - // When a solution is not specified, all the campaigns associated with the account - // are listed. - SolutionArn *string `locationName:"solutionArn" type:"string"` + // The Amazon Resource Name (ARN) of the solution version that the batch segment + // jobs used to generate batch segments. + SolutionVersionArn *string `locationName:"solutionVersionArn" type:"string"` } // String returns the string representation. @@ -11490,7 +13268,7 @@ type ListCampaignsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListCampaignsInput) String() string { +func (s ListBatchSegmentJobsInput) String() string { return awsutil.Prettify(s) } @@ -11499,13 +13277,13 @@ func (s ListCampaignsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListCampaignsInput) GoString() string { +func (s ListBatchSegmentJobsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListCampaignsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListCampaignsInput"} +func (s *ListBatchSegmentJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListBatchSegmentJobsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -11517,30 +13295,31 @@ func (s *ListCampaignsInput) Validate() error { } // SetMaxResults sets the MaxResults field's value. -func (s *ListCampaignsInput) SetMaxResults(v int64) *ListCampaignsInput { +func (s *ListBatchSegmentJobsInput) SetMaxResults(v int64) *ListBatchSegmentJobsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListCampaignsInput) SetNextToken(v string) *ListCampaignsInput { +func (s *ListBatchSegmentJobsInput) SetNextToken(v string) *ListBatchSegmentJobsInput { s.NextToken = &v return s } -// SetSolutionArn sets the SolutionArn field's value. -func (s *ListCampaignsInput) SetSolutionArn(v string) *ListCampaignsInput { - s.SolutionArn = &v +// SetSolutionVersionArn sets the SolutionVersionArn field's value. +func (s *ListBatchSegmentJobsInput) SetSolutionVersionArn(v string) *ListBatchSegmentJobsInput { + s.SolutionVersionArn = &v return s } -type ListCampaignsOutput struct { +type ListBatchSegmentJobsOutput struct { _ struct{} `type:"structure"` - // A list of the campaigns. - Campaigns []*CampaignSummary `locationName:"campaigns" type:"list"` + // A list containing information on each job that is returned. + BatchSegmentJobs []*BatchSegmentJobSummary `locationName:"batchSegmentJobs" type:"list"` - // A token for getting the next set of campaigns (if they exist). + // The token to use to retrieve the next page of results. The value is null + // when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` } @@ -11549,7 +13328,7 @@ type ListCampaignsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListCampaignsOutput) String() string { +func (s ListBatchSegmentJobsOutput) String() string { return awsutil.Prettify(s) } @@ -11558,35 +13337,36 @@ func (s ListCampaignsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListCampaignsOutput) GoString() string { +func (s ListBatchSegmentJobsOutput) GoString() string { return s.String() } -// SetCampaigns sets the Campaigns field's value. -func (s *ListCampaignsOutput) SetCampaigns(v []*CampaignSummary) *ListCampaignsOutput { - s.Campaigns = v +// SetBatchSegmentJobs sets the BatchSegmentJobs field's value. +func (s *ListBatchSegmentJobsOutput) SetBatchSegmentJobs(v []*BatchSegmentJobSummary) *ListBatchSegmentJobsOutput { + s.BatchSegmentJobs = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListCampaignsOutput) SetNextToken(v string) *ListCampaignsOutput { +func (s *ListBatchSegmentJobsOutput) SetNextToken(v string) *ListBatchSegmentJobsOutput { s.NextToken = &v return s } -type ListDatasetExportJobsInput struct { +type ListCampaignsInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset to list the dataset export - // jobs for. - DatasetArn *string `locationName:"datasetArn" type:"string"` - - // The maximum number of dataset export jobs to return. + // The maximum number of campaigns to return. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` - // A token returned from the previous call to ListDatasetExportJobs for getting - // the next set of dataset export jobs (if they exist). + // A token returned from the previous call to ListCampaigns for getting the + // next set of campaigns (if they exist). NextToken *string `locationName:"nextToken" type:"string"` + + // The Amazon Resource Name (ARN) of the solution to list the campaigns for. + // When a solution is not specified, all the campaigns associated with the account + // are listed. + SolutionArn *string `locationName:"solutionArn" type:"string"` } // String returns the string representation. @@ -11594,7 +13374,7 @@ type ListDatasetExportJobsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetExportJobsInput) String() string { +func (s ListCampaignsInput) String() string { return awsutil.Prettify(s) } @@ -11603,13 +13383,13 @@ func (s ListDatasetExportJobsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetExportJobsInput) GoString() string { +func (s ListCampaignsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDatasetExportJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDatasetExportJobsInput"} +func (s *ListCampaignsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListCampaignsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -11620,29 +13400,133 @@ func (s *ListDatasetExportJobsInput) Validate() error { return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *ListDatasetExportJobsInput) SetDatasetArn(v string) *ListDatasetExportJobsInput { - s.DatasetArn = &v - return s -} - // SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetExportJobsInput) SetMaxResults(v int64) *ListDatasetExportJobsInput { +func (s *ListCampaignsInput) SetMaxResults(v int64) *ListCampaignsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetExportJobsInput) SetNextToken(v string) *ListDatasetExportJobsInput { +func (s *ListCampaignsInput) SetNextToken(v string) *ListCampaignsInput { s.NextToken = &v return s } -type ListDatasetExportJobsOutput struct { - _ struct{} `type:"structure"` +// SetSolutionArn sets the SolutionArn field's value. +func (s *ListCampaignsInput) SetSolutionArn(v string) *ListCampaignsInput { + s.SolutionArn = &v + return s +} - // The list of dataset export jobs. - DatasetExportJobs []*DatasetExportJobSummary `locationName:"datasetExportJobs" type:"list"` +type ListCampaignsOutput struct { + _ struct{} `type:"structure"` + + // A list of the campaigns. + Campaigns []*CampaignSummary `locationName:"campaigns" type:"list"` + + // A token for getting the next set of campaigns (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCampaignsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListCampaignsOutput) GoString() string { + return s.String() +} + +// SetCampaigns sets the Campaigns field's value. +func (s *ListCampaignsOutput) SetCampaigns(v []*CampaignSummary) *ListCampaignsOutput { + s.Campaigns = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListCampaignsOutput) SetNextToken(v string) *ListCampaignsOutput { + s.NextToken = &v + return s +} + +type ListDatasetExportJobsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset to list the dataset export + // jobs for. + DatasetArn *string `locationName:"datasetArn" type:"string"` + + // The maximum number of dataset export jobs to return. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // A token returned from the previous call to ListDatasetExportJobs for getting + // the next set of dataset export jobs (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetExportJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetExportJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDatasetExportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetExportJobsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetArn sets the DatasetArn field's value. +func (s *ListDatasetExportJobsInput) SetDatasetArn(v string) *ListDatasetExportJobsInput { + s.DatasetArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetExportJobsInput) SetMaxResults(v int64) *ListDatasetExportJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetExportJobsInput) SetNextToken(v string) *ListDatasetExportJobsInput { + s.NextToken = &v + return s +} + +type ListDatasetExportJobsOutput struct { + _ struct{} `type:"structure"` + + // The list of dataset export jobs. + DatasetExportJobs []*DatasetExportJobSummary `locationName:"datasetExportJobs" type:"list"` // A token for getting the next set of dataset export jobs (if they exist). NextToken *string `locationName:"nextToken" type:"string"` @@ -12189,6 +14073,11 @@ func (s *ListFiltersOutput) SetNextToken(v string) *ListFiltersOutput { type ListRecipesInput struct { _ struct{} `type:"structure"` + // Filters returned recipes by domain for a Domain dataset group. Only recipes + // (Domain dataset group use cases) for this domain are included in the response. + // If you don't specify a domain, only non-domain recipes are returned. + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + // The maximum number of recipes to return. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -12231,6 +14120,12 @@ func (s *ListRecipesInput) Validate() error { return nil } +// SetDomain sets the Domain field's value. +func (s *ListRecipesInput) SetDomain(v string) *ListRecipesInput { + s.Domain = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListRecipesInput) SetMaxResults(v int64) *ListRecipesInput { s.MaxResults = &v @@ -12289,6 +14184,111 @@ func (s *ListRecipesOutput) SetRecipes(v []*RecipeSummary) *ListRecipesOutput { return s } +type ListRecommendersInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders + // for. When a Domain dataset group is not specified, all the recommenders associated + // with the account are listed. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // The maximum number of recommenders to return. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // A token returned from the previous call to ListRecommenders for getting the + // next set of recommenders (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRecommendersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRecommendersInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *ListRecommendersInput) SetDatasetGroupArn(v string) *ListRecommendersInput { + s.DatasetGroupArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRecommendersInput) SetMaxResults(v int64) *ListRecommendersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRecommendersInput) SetNextToken(v string) *ListRecommendersInput { + s.NextToken = &v + return s +} + +type ListRecommendersOutput struct { + _ struct{} `type:"structure"` + + // A token for getting the next set of recommenders (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` + + // A list of the recommenders. + Recommenders []*RecommenderSummary `locationName:"recommenders" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRecommendersOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRecommendersOutput) SetNextToken(v string) *ListRecommendersOutput { + s.NextToken = &v + return s +} + +// SetRecommenders sets the Recommenders field's value. +func (s *ListRecommendersOutput) SetRecommenders(v []*RecommenderSummary) *ListRecommendersOutput { + s.Recommenders = v + return s +} + type ListSchemasInput struct { _ struct{} `type:"structure"` @@ -12532,77 +14532,447 @@ func (s *ListSolutionsInput) Validate() error { } // SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ListSolutionsInput) SetDatasetGroupArn(v string) *ListSolutionsInput { +func (s *ListSolutionsInput) SetDatasetGroupArn(v string) *ListSolutionsInput { + s.DatasetGroupArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSolutionsInput) SetMaxResults(v int64) *ListSolutionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSolutionsInput) SetNextToken(v string) *ListSolutionsInput { + s.NextToken = &v + return s +} + +type ListSolutionsOutput struct { + _ struct{} `type:"structure"` + + // A token for getting the next set of solutions (if they exist). + NextToken *string `locationName:"nextToken" type:"string"` + + // A list of the current solutions. + Solutions []*SolutionSummary `locationName:"solutions" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSolutionsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSolutionsOutput) SetNextToken(v string) *ListSolutionsOutput { + s.NextToken = &v + return s +} + +// SetSolutions sets the Solutions field's value. +func (s *ListSolutionsOutput) SetSolutions(v []*SolutionSummary) *ListSolutionsOutput { + s.Solutions = v + return s +} + +// Describes the additional objective for the solution, such as maximizing streaming +// minutes or increasing revenue. For more information see Optimizing a solution +// (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html). +type OptimizationObjective struct { + _ struct{} `type:"structure"` + + // The numerical metadata column in an Items dataset related to the optimization + // objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or + // PRICE (to maximize revenue). + ItemAttribute *string `locationName:"itemAttribute" min:"1" type:"string"` + + // Specifies how Amazon Personalize balances the importance of your optimization + // objective versus relevance. + ObjectiveSensitivity *string `locationName:"objectiveSensitivity" type:"string" enum:"ObjectiveSensitivity"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptimizationObjective) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptimizationObjective) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OptimizationObjective) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OptimizationObjective"} + if s.ItemAttribute != nil && len(*s.ItemAttribute) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ItemAttribute", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetItemAttribute sets the ItemAttribute field's value. +func (s *OptimizationObjective) SetItemAttribute(v string) *OptimizationObjective { + s.ItemAttribute = &v + return s +} + +// SetObjectiveSensitivity sets the ObjectiveSensitivity field's value. +func (s *OptimizationObjective) SetObjectiveSensitivity(v string) *OptimizationObjective { + s.ObjectiveSensitivity = &v + return s +} + +// Provides information about a recipe. Each recipe provides an algorithm that +// Amazon Personalize uses in model training when you use the CreateSolution +// operation. +type Recipe struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses + // to train the model. + AlgorithmArn *string `locationName:"algorithmArn" type:"string"` + + // The date and time (in Unix format) that the recipe was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The description of the recipe. + Description *string `locationName:"description" type:"string"` + + // The ARN of the FeatureTransformation object. + FeatureTransformationArn *string `locationName:"featureTransformationArn" type:"string"` + + // The date and time (in Unix format) that the recipe was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The name of the recipe. + Name *string `locationName:"name" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the recipe. + RecipeArn *string `locationName:"recipeArn" type:"string"` + + // One of the following values: + // + // * PERSONALIZED_RANKING + // + // * RELATED_ITEMS + // + // * USER_PERSONALIZATION + RecipeType *string `locationName:"recipeType" type:"string"` + + // The status of the recipe. + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recipe) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recipe) GoString() string { + return s.String() +} + +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *Recipe) SetAlgorithmArn(v string) *Recipe { + s.AlgorithmArn = &v + return s +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *Recipe) SetCreationDateTime(v time.Time) *Recipe { + s.CreationDateTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Recipe) SetDescription(v string) *Recipe { + s.Description = &v + return s +} + +// SetFeatureTransformationArn sets the FeatureTransformationArn field's value. +func (s *Recipe) SetFeatureTransformationArn(v string) *Recipe { + s.FeatureTransformationArn = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *Recipe) SetLastUpdatedDateTime(v time.Time) *Recipe { + s.LastUpdatedDateTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *Recipe) SetName(v string) *Recipe { + s.Name = &v + return s +} + +// SetRecipeArn sets the RecipeArn field's value. +func (s *Recipe) SetRecipeArn(v string) *Recipe { + s.RecipeArn = &v + return s +} + +// SetRecipeType sets the RecipeType field's value. +func (s *Recipe) SetRecipeType(v string) *Recipe { + s.RecipeType = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *Recipe) SetStatus(v string) *Recipe { + s.Status = &v + return s +} + +// Provides a summary of the properties of a recipe. For a complete listing, +// call the DescribeRecipe API. +type RecipeSummary struct { + _ struct{} `type:"structure"` + + // The date and time (in Unix time) that the recipe was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The domain of the recipe (if the recipe is a Domain dataset group use case). + Domain *string `locationName:"domain" type:"string" enum:"Domain"` + + // The date and time (in Unix time) that the recipe was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // The name of the recipe. + Name *string `locationName:"name" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the recipe. + RecipeArn *string `locationName:"recipeArn" type:"string"` + + // The status of the recipe. + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecipeSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RecipeSummary) GoString() string { + return s.String() +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *RecipeSummary) SetCreationDateTime(v time.Time) *RecipeSummary { + s.CreationDateTime = &v + return s +} + +// SetDomain sets the Domain field's value. +func (s *RecipeSummary) SetDomain(v string) *RecipeSummary { + s.Domain = &v + return s +} + +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *RecipeSummary) SetLastUpdatedDateTime(v time.Time) *RecipeSummary { + s.LastUpdatedDateTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *RecipeSummary) SetName(v string) *RecipeSummary { + s.Name = &v + return s +} + +// SetRecipeArn sets the RecipeArn field's value. +func (s *RecipeSummary) SetRecipeArn(v string) *RecipeSummary { + s.RecipeArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *RecipeSummary) SetStatus(v string) *RecipeSummary { + s.Status = &v + return s +} + +// Describes a recommendation generator for a Domain dataset group. You create +// a recommender in a Domain dataset group for a specific domain use case (domain +// recipe), and specify the recommender in a GetRecommendations (https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) +// request. +type Recommender struct { + _ struct{} `type:"structure"` + + // The date and time (in Unix format) that the recommender was created. + CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the Domain dataset group that contains + // the recommender. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` + + // If a recommender fails, the reason behind the failure. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The date and time (in Unix format) that the recommender was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + + // Provides a summary of the latest updates to the recommender. + LatestRecommenderUpdate *RecommenderUpdateSummary `locationName:"latestRecommenderUpdate" type:"structure"` + + // The name of the recommender. + Name *string `locationName:"name" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) + // that the recommender was created for. + RecipeArn *string `locationName:"recipeArn" type:"string"` + + // The Amazon Resource Name (ARN) of the recommender. + RecommenderArn *string `locationName:"recommenderArn" type:"string"` + + // The configuration details of the recommender. + RecommenderConfig *RecommenderConfig `locationName:"recommenderConfig" type:"structure"` + + // The status of the recommender. + // + // A recommender can be in one of the following states: + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // + // * DELETE PENDING > DELETE IN_PROGRESS + Status *string `locationName:"status" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recommender) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Recommender) GoString() string { + return s.String() +} + +// SetCreationDateTime sets the CreationDateTime field's value. +func (s *Recommender) SetCreationDateTime(v time.Time) *Recommender { + s.CreationDateTime = &v + return s +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *Recommender) SetDatasetGroupArn(v string) *Recommender { s.DatasetGroupArn = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListSolutionsInput) SetMaxResults(v int64) *ListSolutionsInput { - s.MaxResults = &v +// SetFailureReason sets the FailureReason field's value. +func (s *Recommender) SetFailureReason(v string) *Recommender { + s.FailureReason = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListSolutionsInput) SetNextToken(v string) *ListSolutionsInput { - s.NextToken = &v +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *Recommender) SetLastUpdatedDateTime(v time.Time) *Recommender { + s.LastUpdatedDateTime = &v return s } -type ListSolutionsOutput struct { - _ struct{} `type:"structure"` - - // A token for getting the next set of solutions (if they exist). - NextToken *string `locationName:"nextToken" type:"string"` +// SetLatestRecommenderUpdate sets the LatestRecommenderUpdate field's value. +func (s *Recommender) SetLatestRecommenderUpdate(v *RecommenderUpdateSummary) *Recommender { + s.LatestRecommenderUpdate = v + return s +} - // A list of the current solutions. - Solutions []*SolutionSummary `locationName:"solutions" type:"list"` +// SetName sets the Name field's value. +func (s *Recommender) SetName(v string) *Recommender { + s.Name = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s ListSolutionsOutput) String() string { - return awsutil.Prettify(s) +// SetRecipeArn sets the RecipeArn field's value. +func (s *Recommender) SetRecipeArn(v string) *Recommender { + s.RecipeArn = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s ListSolutionsOutput) GoString() string { - return s.String() +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *Recommender) SetRecommenderArn(v string) *Recommender { + s.RecommenderArn = &v + return s } -// SetNextToken sets the NextToken field's value. -func (s *ListSolutionsOutput) SetNextToken(v string) *ListSolutionsOutput { - s.NextToken = &v +// SetRecommenderConfig sets the RecommenderConfig field's value. +func (s *Recommender) SetRecommenderConfig(v *RecommenderConfig) *Recommender { + s.RecommenderConfig = v return s } -// SetSolutions sets the Solutions field's value. -func (s *ListSolutionsOutput) SetSolutions(v []*SolutionSummary) *ListSolutionsOutput { - s.Solutions = v +// SetStatus sets the Status field's value. +func (s *Recommender) SetStatus(v string) *Recommender { + s.Status = &v return s } -// Describes the additional objective for the solution, such as maximizing streaming -// minutes or increasing revenue. For more information see Optimizing a solution -// (https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html). -type OptimizationObjective struct { +// The configuration details of the recommender. +type RecommenderConfig struct { _ struct{} `type:"structure"` - // The numerical metadata column in an Items dataset related to the optimization - // objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or - // PRICE (to maximize revenue). - ItemAttribute *string `locationName:"itemAttribute" min:"1" type:"string"` - - // Specifies how Amazon Personalize balances the importance of your optimization - // objective versus relevance. - ObjectiveSensitivity *string `locationName:"objectiveSensitivity" type:"string" enum:"ObjectiveSensitivity"` + // Specifies the exploration configuration hyperparameters, including explorationWeight + // and explorationItemAgeCutOff, you want to use to configure the amount of + // item exploration Amazon Personalize uses when recommending items. Provide + // itemExplorationConfig data only if your recommenders generate personalized + // recommendations for a user (not popular items or similar items). + ItemExplorationConfig map[string]*string `locationName:"itemExplorationConfig" type:"map"` } // String returns the string representation. @@ -12610,7 +14980,7 @@ type OptimizationObjective struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s OptimizationObjective) String() string { +func (s RecommenderConfig) String() string { return awsutil.Prettify(s) } @@ -12619,73 +14989,49 @@ func (s OptimizationObjective) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s OptimizationObjective) GoString() string { +func (s RecommenderConfig) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *OptimizationObjective) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "OptimizationObjective"} - if s.ItemAttribute != nil && len(*s.ItemAttribute) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ItemAttribute", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetItemAttribute sets the ItemAttribute field's value. -func (s *OptimizationObjective) SetItemAttribute(v string) *OptimizationObjective { - s.ItemAttribute = &v - return s -} - -// SetObjectiveSensitivity sets the ObjectiveSensitivity field's value. -func (s *OptimizationObjective) SetObjectiveSensitivity(v string) *OptimizationObjective { - s.ObjectiveSensitivity = &v +// SetItemExplorationConfig sets the ItemExplorationConfig field's value. +func (s *RecommenderConfig) SetItemExplorationConfig(v map[string]*string) *RecommenderConfig { + s.ItemExplorationConfig = v return s } -// Provides information about a recipe. Each recipe provides an algorithm that -// Amazon Personalize uses in model training when you use the CreateSolution -// operation. -type Recipe struct { +// Provides a summary of the properties of the recommender. +type RecommenderSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses - // to train the model. - AlgorithmArn *string `locationName:"algorithmArn" type:"string"` - - // The date and time (in Unix format) that the recipe was created. + // The date and time (in Unix format) that the recommender was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` - // The description of the recipe. - Description *string `locationName:"description" type:"string"` - - // The ARN of the FeatureTransformation object. - FeatureTransformationArn *string `locationName:"featureTransformationArn" type:"string"` + // The Amazon Resource Name (ARN) of the Domain dataset group that contains + // the recommender. + DatasetGroupArn *string `locationName:"datasetGroupArn" type:"string"` - // The date and time (in Unix format) that the recipe was last updated. + // The date and time (in Unix format) that the recommender was last updated. LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` - // The name of the recipe. + // The name of the recommender. Name *string `locationName:"name" min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the recipe. + // The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) + // that the recommender was created for. RecipeArn *string `locationName:"recipeArn" type:"string"` - // One of the following values: - // - // * PERSONALIZED_RANKING + // The Amazon Resource Name (ARN) of the recommender. + RecommenderArn *string `locationName:"recommenderArn" type:"string"` + + // The configuration details of the recommender. + RecommenderConfig *RecommenderConfig `locationName:"recommenderConfig" type:"structure"` + + // The status of the recommender. A recommender can be in one of the following + // states: // - // * RELATED_ITEMS + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED // - // * USER_PERSONALIZATION - RecipeType *string `locationName:"recipeType" type:"string"` - - // The status of the recipe. + // * DELETE PENDING > DELETE IN_PROGRESS Status *string `locationName:"status" type:"string"` } @@ -12694,7 +15040,7 @@ type Recipe struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Recipe) String() string { +func (s RecommenderSummary) String() string { return awsutil.Prettify(s) } @@ -12703,82 +15049,82 @@ func (s Recipe) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s Recipe) GoString() string { +func (s RecommenderSummary) GoString() string { return s.String() } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *Recipe) SetAlgorithmArn(v string) *Recipe { - s.AlgorithmArn = &v - return s -} - // SetCreationDateTime sets the CreationDateTime field's value. -func (s *Recipe) SetCreationDateTime(v time.Time) *Recipe { +func (s *RecommenderSummary) SetCreationDateTime(v time.Time) *RecommenderSummary { s.CreationDateTime = &v return s } -// SetDescription sets the Description field's value. -func (s *Recipe) SetDescription(v string) *Recipe { - s.Description = &v - return s -} - -// SetFeatureTransformationArn sets the FeatureTransformationArn field's value. -func (s *Recipe) SetFeatureTransformationArn(v string) *Recipe { - s.FeatureTransformationArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *RecommenderSummary) SetDatasetGroupArn(v string) *RecommenderSummary { + s.DatasetGroupArn = &v return s } // SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. -func (s *Recipe) SetLastUpdatedDateTime(v time.Time) *Recipe { +func (s *RecommenderSummary) SetLastUpdatedDateTime(v time.Time) *RecommenderSummary { s.LastUpdatedDateTime = &v return s } // SetName sets the Name field's value. -func (s *Recipe) SetName(v string) *Recipe { +func (s *RecommenderSummary) SetName(v string) *RecommenderSummary { s.Name = &v return s } // SetRecipeArn sets the RecipeArn field's value. -func (s *Recipe) SetRecipeArn(v string) *Recipe { +func (s *RecommenderSummary) SetRecipeArn(v string) *RecommenderSummary { s.RecipeArn = &v return s } -// SetRecipeType sets the RecipeType field's value. -func (s *Recipe) SetRecipeType(v string) *Recipe { - s.RecipeType = &v +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *RecommenderSummary) SetRecommenderArn(v string) *RecommenderSummary { + s.RecommenderArn = &v + return s +} + +// SetRecommenderConfig sets the RecommenderConfig field's value. +func (s *RecommenderSummary) SetRecommenderConfig(v *RecommenderConfig) *RecommenderSummary { + s.RecommenderConfig = v return s } // SetStatus sets the Status field's value. -func (s *Recipe) SetStatus(v string) *Recipe { +func (s *RecommenderSummary) SetStatus(v string) *RecommenderSummary { s.Status = &v return s } -// Provides a summary of the properties of a recipe. For a complete listing, -// call the DescribeRecipe API. -type RecipeSummary struct { +// Provides a summary of the properties of a recommender update. For a complete +// listing, call the DescribeRecommender API. +type RecommenderUpdateSummary struct { _ struct{} `type:"structure"` - // The date and time (in Unix time) that the recipe was created. + // The date and time (in Unix format) that the recommender update was created. CreationDateTime *time.Time `locationName:"creationDateTime" type:"timestamp"` - // The date and time (in Unix time) that the recipe was last updated. - LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` + // If a recommender update fails, the reason behind the failure. + FailureReason *string `locationName:"failureReason" type:"string"` - // The name of the recipe. - Name *string `locationName:"name" min:"1" type:"string"` + // The date and time (in Unix time) that the recommender update was last updated. + LastUpdatedDateTime *time.Time `locationName:"lastUpdatedDateTime" type:"timestamp"` - // The Amazon Resource Name (ARN) of the recipe. - RecipeArn *string `locationName:"recipeArn" type:"string"` + // The configuration details of the recommender update. + RecommenderConfig *RecommenderConfig `locationName:"recommenderConfig" type:"structure"` - // The status of the recipe. + // The status of the recommender update. + // + // A recommender can be in one of the following states: + // + // * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED + // + // * DELETE PENDING > DELETE IN_PROGRESS Status *string `locationName:"status" type:"string"` } @@ -12787,7 +15133,7 @@ type RecipeSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s RecipeSummary) String() string { +func (s RecommenderUpdateSummary) String() string { return awsutil.Prettify(s) } @@ -12796,36 +15142,36 @@ func (s RecipeSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s RecipeSummary) GoString() string { +func (s RecommenderUpdateSummary) GoString() string { return s.String() } // SetCreationDateTime sets the CreationDateTime field's value. -func (s *RecipeSummary) SetCreationDateTime(v time.Time) *RecipeSummary { +func (s *RecommenderUpdateSummary) SetCreationDateTime(v time.Time) *RecommenderUpdateSummary { s.CreationDateTime = &v return s } -// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. -func (s *RecipeSummary) SetLastUpdatedDateTime(v time.Time) *RecipeSummary { - s.LastUpdatedDateTime = &v +// SetFailureReason sets the FailureReason field's value. +func (s *RecommenderUpdateSummary) SetFailureReason(v string) *RecommenderUpdateSummary { + s.FailureReason = &v return s } -// SetName sets the Name field's value. -func (s *RecipeSummary) SetName(v string) *RecipeSummary { - s.Name = &v +// SetLastUpdatedDateTime sets the LastUpdatedDateTime field's value. +func (s *RecommenderUpdateSummary) SetLastUpdatedDateTime(v time.Time) *RecommenderUpdateSummary { + s.LastUpdatedDateTime = &v return s } -// SetRecipeArn sets the RecipeArn field's value. -func (s *RecipeSummary) SetRecipeArn(v string) *RecipeSummary { - s.RecipeArn = &v +// SetRecommenderConfig sets the RecommenderConfig field's value. +func (s *RecommenderUpdateSummary) SetRecommenderConfig(v *RecommenderConfig) *RecommenderUpdateSummary { + s.RecommenderConfig = v return s } // SetStatus sets the Status field's value. -func (s *RecipeSummary) SetStatus(v string) *RecipeSummary { +func (s *RecommenderUpdateSummary) SetStatus(v string) *RecommenderUpdateSummary { s.Status = &v return s } @@ -13411,7 +15757,8 @@ func (s *SolutionSummary) SetStatus(v string) *SolutionSummary { return s } -// An object that provides information about a specific version of a Solution. +// An object that provides information about a specific version of a Solution +// in a Custom dataset group. type SolutionVersion struct { _ struct{} `type:"structure"` @@ -13884,6 +16231,113 @@ func (s *UpdateCampaignOutput) SetCampaignArn(v string) *UpdateCampaignOutput { return s } +type UpdateRecommenderInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the recommender to modify. + // + // RecommenderArn is a required field + RecommenderArn *string `locationName:"recommenderArn" type:"string" required:"true"` + + // The configuration details of the recommender. + // + // RecommenderConfig is a required field + RecommenderConfig *RecommenderConfig `locationName:"recommenderConfig" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRecommenderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRecommenderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateRecommenderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateRecommenderInput"} + if s.RecommenderArn == nil { + invalidParams.Add(request.NewErrParamRequired("RecommenderArn")) + } + if s.RecommenderConfig == nil { + invalidParams.Add(request.NewErrParamRequired("RecommenderConfig")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *UpdateRecommenderInput) SetRecommenderArn(v string) *UpdateRecommenderInput { + s.RecommenderArn = &v + return s +} + +// SetRecommenderConfig sets the RecommenderConfig field's value. +func (s *UpdateRecommenderInput) SetRecommenderConfig(v *RecommenderConfig) *UpdateRecommenderInput { + s.RecommenderConfig = v + return s +} + +type UpdateRecommenderOutput struct { + _ struct{} `type:"structure"` + + // The same recommender Amazon Resource Name (ARN) as given in the request. + RecommenderArn *string `locationName:"recommenderArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRecommenderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRecommenderOutput) GoString() string { + return s.String() +} + +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *UpdateRecommenderOutput) SetRecommenderArn(v string) *UpdateRecommenderOutput { + s.RecommenderArn = &v + return s +} + +const ( + // DomainEcommerce is a Domain enum value + DomainEcommerce = "ECOMMERCE" + + // DomainVideoOnDemand is a Domain enum value + DomainVideoOnDemand = "VIDEO_ON_DEMAND" +) + +// Domain_Values returns all elements of the Domain enum +func Domain_Values() []string { + return []string{ + DomainEcommerce, + DomainVideoOnDemand, + } +} + const ( // IngestionModeBulk is a IngestionMode enum value IngestionModeBulk = "BULK" diff --git a/service/personalize/personalizeiface/interface.go b/service/personalize/personalizeiface/interface.go index a72941412b8..11babe18591 100644 --- a/service/personalize/personalizeiface/interface.go +++ b/service/personalize/personalizeiface/interface.go @@ -64,6 +64,10 @@ type PersonalizeAPI interface { CreateBatchInferenceJobWithContext(aws.Context, *personalize.CreateBatchInferenceJobInput, ...request.Option) (*personalize.CreateBatchInferenceJobOutput, error) CreateBatchInferenceJobRequest(*personalize.CreateBatchInferenceJobInput) (*request.Request, *personalize.CreateBatchInferenceJobOutput) + CreateBatchSegmentJob(*personalize.CreateBatchSegmentJobInput) (*personalize.CreateBatchSegmentJobOutput, error) + CreateBatchSegmentJobWithContext(aws.Context, *personalize.CreateBatchSegmentJobInput, ...request.Option) (*personalize.CreateBatchSegmentJobOutput, error) + CreateBatchSegmentJobRequest(*personalize.CreateBatchSegmentJobInput) (*request.Request, *personalize.CreateBatchSegmentJobOutput) + CreateCampaign(*personalize.CreateCampaignInput) (*personalize.CreateCampaignOutput, error) CreateCampaignWithContext(aws.Context, *personalize.CreateCampaignInput, ...request.Option) (*personalize.CreateCampaignOutput, error) CreateCampaignRequest(*personalize.CreateCampaignInput) (*request.Request, *personalize.CreateCampaignOutput) @@ -92,6 +96,10 @@ type PersonalizeAPI interface { CreateFilterWithContext(aws.Context, *personalize.CreateFilterInput, ...request.Option) (*personalize.CreateFilterOutput, error) CreateFilterRequest(*personalize.CreateFilterInput) (*request.Request, *personalize.CreateFilterOutput) + CreateRecommender(*personalize.CreateRecommenderInput) (*personalize.CreateRecommenderOutput, error) + CreateRecommenderWithContext(aws.Context, *personalize.CreateRecommenderInput, ...request.Option) (*personalize.CreateRecommenderOutput, error) + CreateRecommenderRequest(*personalize.CreateRecommenderInput) (*request.Request, *personalize.CreateRecommenderOutput) + CreateSchema(*personalize.CreateSchemaInput) (*personalize.CreateSchemaOutput, error) CreateSchemaWithContext(aws.Context, *personalize.CreateSchemaInput, ...request.Option) (*personalize.CreateSchemaOutput, error) CreateSchemaRequest(*personalize.CreateSchemaInput) (*request.Request, *personalize.CreateSchemaOutput) @@ -124,6 +132,10 @@ type PersonalizeAPI interface { DeleteFilterWithContext(aws.Context, *personalize.DeleteFilterInput, ...request.Option) (*personalize.DeleteFilterOutput, error) DeleteFilterRequest(*personalize.DeleteFilterInput) (*request.Request, *personalize.DeleteFilterOutput) + DeleteRecommender(*personalize.DeleteRecommenderInput) (*personalize.DeleteRecommenderOutput, error) + DeleteRecommenderWithContext(aws.Context, *personalize.DeleteRecommenderInput, ...request.Option) (*personalize.DeleteRecommenderOutput, error) + DeleteRecommenderRequest(*personalize.DeleteRecommenderInput) (*request.Request, *personalize.DeleteRecommenderOutput) + DeleteSchema(*personalize.DeleteSchemaInput) (*personalize.DeleteSchemaOutput, error) DeleteSchemaWithContext(aws.Context, *personalize.DeleteSchemaInput, ...request.Option) (*personalize.DeleteSchemaOutput, error) DeleteSchemaRequest(*personalize.DeleteSchemaInput) (*request.Request, *personalize.DeleteSchemaOutput) @@ -140,6 +152,10 @@ type PersonalizeAPI interface { DescribeBatchInferenceJobWithContext(aws.Context, *personalize.DescribeBatchInferenceJobInput, ...request.Option) (*personalize.DescribeBatchInferenceJobOutput, error) DescribeBatchInferenceJobRequest(*personalize.DescribeBatchInferenceJobInput) (*request.Request, *personalize.DescribeBatchInferenceJobOutput) + DescribeBatchSegmentJob(*personalize.DescribeBatchSegmentJobInput) (*personalize.DescribeBatchSegmentJobOutput, error) + DescribeBatchSegmentJobWithContext(aws.Context, *personalize.DescribeBatchSegmentJobInput, ...request.Option) (*personalize.DescribeBatchSegmentJobOutput, error) + DescribeBatchSegmentJobRequest(*personalize.DescribeBatchSegmentJobInput) (*request.Request, *personalize.DescribeBatchSegmentJobOutput) + DescribeCampaign(*personalize.DescribeCampaignInput) (*personalize.DescribeCampaignOutput, error) DescribeCampaignWithContext(aws.Context, *personalize.DescribeCampaignInput, ...request.Option) (*personalize.DescribeCampaignOutput, error) DescribeCampaignRequest(*personalize.DescribeCampaignInput) (*request.Request, *personalize.DescribeCampaignOutput) @@ -176,6 +192,10 @@ type PersonalizeAPI interface { DescribeRecipeWithContext(aws.Context, *personalize.DescribeRecipeInput, ...request.Option) (*personalize.DescribeRecipeOutput, error) DescribeRecipeRequest(*personalize.DescribeRecipeInput) (*request.Request, *personalize.DescribeRecipeOutput) + DescribeRecommender(*personalize.DescribeRecommenderInput) (*personalize.DescribeRecommenderOutput, error) + DescribeRecommenderWithContext(aws.Context, *personalize.DescribeRecommenderInput, ...request.Option) (*personalize.DescribeRecommenderOutput, error) + DescribeRecommenderRequest(*personalize.DescribeRecommenderInput) (*request.Request, *personalize.DescribeRecommenderOutput) + DescribeSchema(*personalize.DescribeSchemaInput) (*personalize.DescribeSchemaOutput, error) DescribeSchemaWithContext(aws.Context, *personalize.DescribeSchemaInput, ...request.Option) (*personalize.DescribeSchemaOutput, error) DescribeSchemaRequest(*personalize.DescribeSchemaInput) (*request.Request, *personalize.DescribeSchemaOutput) @@ -199,6 +219,13 @@ type PersonalizeAPI interface { ListBatchInferenceJobsPages(*personalize.ListBatchInferenceJobsInput, func(*personalize.ListBatchInferenceJobsOutput, bool) bool) error ListBatchInferenceJobsPagesWithContext(aws.Context, *personalize.ListBatchInferenceJobsInput, func(*personalize.ListBatchInferenceJobsOutput, bool) bool, ...request.Option) error + ListBatchSegmentJobs(*personalize.ListBatchSegmentJobsInput) (*personalize.ListBatchSegmentJobsOutput, error) + ListBatchSegmentJobsWithContext(aws.Context, *personalize.ListBatchSegmentJobsInput, ...request.Option) (*personalize.ListBatchSegmentJobsOutput, error) + ListBatchSegmentJobsRequest(*personalize.ListBatchSegmentJobsInput) (*request.Request, *personalize.ListBatchSegmentJobsOutput) + + ListBatchSegmentJobsPages(*personalize.ListBatchSegmentJobsInput, func(*personalize.ListBatchSegmentJobsOutput, bool) bool) error + ListBatchSegmentJobsPagesWithContext(aws.Context, *personalize.ListBatchSegmentJobsInput, func(*personalize.ListBatchSegmentJobsOutput, bool) bool, ...request.Option) error + ListCampaigns(*personalize.ListCampaignsInput) (*personalize.ListCampaignsOutput, error) ListCampaignsWithContext(aws.Context, *personalize.ListCampaignsInput, ...request.Option) (*personalize.ListCampaignsOutput, error) ListCampaignsRequest(*personalize.ListCampaignsInput) (*request.Request, *personalize.ListCampaignsOutput) @@ -255,6 +282,13 @@ type PersonalizeAPI interface { ListRecipesPages(*personalize.ListRecipesInput, func(*personalize.ListRecipesOutput, bool) bool) error ListRecipesPagesWithContext(aws.Context, *personalize.ListRecipesInput, func(*personalize.ListRecipesOutput, bool) bool, ...request.Option) error + ListRecommenders(*personalize.ListRecommendersInput) (*personalize.ListRecommendersOutput, error) + ListRecommendersWithContext(aws.Context, *personalize.ListRecommendersInput, ...request.Option) (*personalize.ListRecommendersOutput, error) + ListRecommendersRequest(*personalize.ListRecommendersInput) (*request.Request, *personalize.ListRecommendersOutput) + + ListRecommendersPages(*personalize.ListRecommendersInput, func(*personalize.ListRecommendersOutput, bool) bool) error + ListRecommendersPagesWithContext(aws.Context, *personalize.ListRecommendersInput, func(*personalize.ListRecommendersOutput, bool) bool, ...request.Option) error + ListSchemas(*personalize.ListSchemasInput) (*personalize.ListSchemasOutput, error) ListSchemasWithContext(aws.Context, *personalize.ListSchemasInput, ...request.Option) (*personalize.ListSchemasOutput, error) ListSchemasRequest(*personalize.ListSchemasInput) (*request.Request, *personalize.ListSchemasOutput) @@ -283,6 +317,10 @@ type PersonalizeAPI interface { UpdateCampaign(*personalize.UpdateCampaignInput) (*personalize.UpdateCampaignOutput, error) UpdateCampaignWithContext(aws.Context, *personalize.UpdateCampaignInput, ...request.Option) (*personalize.UpdateCampaignOutput, error) UpdateCampaignRequest(*personalize.UpdateCampaignInput) (*request.Request, *personalize.UpdateCampaignOutput) + + UpdateRecommender(*personalize.UpdateRecommenderInput) (*personalize.UpdateRecommenderOutput, error) + UpdateRecommenderWithContext(aws.Context, *personalize.UpdateRecommenderInput, ...request.Option) (*personalize.UpdateRecommenderOutput, error) + UpdateRecommenderRequest(*personalize.UpdateRecommenderInput) (*request.Request, *personalize.UpdateRecommenderOutput) } var _ PersonalizeAPI = (*personalize.Personalize)(nil) diff --git a/service/personalizeruntime/api.go b/service/personalizeruntime/api.go index 91018722ad5..96a49769508 100644 --- a/service/personalizeruntime/api.go +++ b/service/personalizeruntime/api.go @@ -141,16 +141,22 @@ func (c *PersonalizeRuntime) GetRecommendationsRequest(input *GetRecommendations // GetRecommendations API operation for Amazon Personalize Runtime. // -// Returns a list of recommended items. The required input depends on the recipe -// type used to create the solution backing the campaign, as follows: +// Returns a list of recommended items. For campaigns, the campaign's Amazon +// Resource Name (ARN) is required and the required user and item input depends +// on the recipe type used to create the solution backing the campaign as follows: // -// * RELATED_ITEMS - itemId required, userId not used +// * USER_PERSONALIZATION - userId required, itemId not used // -// * USER_PERSONALIZATION - itemId optional, userId required +// * RELATED_ITEMS - itemId required, userId not used // // Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING // use the API. // +// For recommenders, the recommender's ARN is required and the required item +// and user input depends on the use case (domain-based recipe) backing the +// recommender. For information on use case requirements see Choosing recommender +// use cases (https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -351,9 +357,7 @@ type GetRecommendationsInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the campaign to use for getting recommendations. - // - // CampaignArn is a required field - CampaignArn *string `locationName:"campaignArn" type:"string" required:"true"` + CampaignArn *string `locationName:"campaignArn" type:"string"` // The contextual metadata to use when getting recommendations. Contextual metadata // includes any interaction information that might be relevant when getting @@ -388,6 +392,11 @@ type GetRecommendationsInput struct { // The number of results to return. The default is 25. The maximum is 500. NumResults *int64 `locationName:"numResults" type:"integer"` + // The Amazon Resource Name (ARN) of the recommender to use to get recommendations. + // Provide a recommender ARN if you created a Domain dataset group with a recommender + // for a domain use case. + RecommenderArn *string `locationName:"recommenderArn" type:"string"` + // The user ID to provide recommendations for. // // Required for USER_PERSONALIZATION recipe type. @@ -412,19 +421,6 @@ func (s GetRecommendationsInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *GetRecommendationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetRecommendationsInput"} - if s.CampaignArn == nil { - invalidParams.Add(request.NewErrParamRequired("CampaignArn")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - // SetCampaignArn sets the CampaignArn field's value. func (s *GetRecommendationsInput) SetCampaignArn(v string) *GetRecommendationsInput { s.CampaignArn = &v @@ -461,6 +457,12 @@ func (s *GetRecommendationsInput) SetNumResults(v int64) *GetRecommendationsInpu return s } +// SetRecommenderArn sets the RecommenderArn field's value. +func (s *GetRecommendationsInput) SetRecommenderArn(v string) *GetRecommendationsInput { + s.RecommenderArn = &v + return s +} + // SetUserId sets the UserId field's value. func (s *GetRecommendationsInput) SetUserId(v string) *GetRecommendationsInput { s.UserId = &v @@ -470,7 +472,7 @@ func (s *GetRecommendationsInput) SetUserId(v string) *GetRecommendationsInput { type GetRecommendationsOutput struct { _ struct{} `type:"structure"` - // A list of recommendations sorted in ascending order by prediction score. + // A list of recommendations sorted in descending order by prediction score. // There can be a maximum of 500 items in the list. ItemList []*PredictedItem `locationName:"itemList" type:"list"` diff --git a/service/textract/api.go b/service/textract/api.go index 94cefc9a87d..46335448397 100644 --- a/service/textract/api.go +++ b/service/textract/api.go @@ -108,8 +108,8 @@ func (c *Textract) AnalyzeDocumentRequest(input *AnalyzeDocumentInput) (req *req // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -205,8 +205,8 @@ func (c *Textract) AnalyzeExpenseRequest(input *AnalyzeExpenseInput) (req *reque // AnalyzeExpense API operation for Amazon Textract. // -// Analyzes an input document for financially related relationships between -// text. +// AnalyzeExpense synchronously analyzes an input document for financially related +// relationships between text. // // Information is returned as ExpenseDocuments and seperated as follows. // @@ -238,8 +238,8 @@ func (c *Textract) AnalyzeExpenseRequest(input *AnalyzeExpenseInput) (req *reque // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -287,6 +287,124 @@ func (c *Textract) AnalyzeExpenseWithContext(ctx aws.Context, input *AnalyzeExpe return out, req.Send() } +const opAnalyzeID = "AnalyzeID" + +// AnalyzeIDRequest generates a "aws/request.Request" representing the +// client's request for the AnalyzeID operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See AnalyzeID for more information on using the AnalyzeID +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the AnalyzeIDRequest method. +// req, resp := client.AnalyzeIDRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeID +func (c *Textract) AnalyzeIDRequest(input *AnalyzeIDInput) (req *request.Request, output *AnalyzeIDOutput) { + op := &request.Operation{ + Name: opAnalyzeID, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AnalyzeIDInput{} + } + + output = &AnalyzeIDOutput{} + req = c.newRequest(op, input, output) + return +} + +// AnalyzeID API operation for Amazon Textract. +// +// Analyzes identity documents for relevant information. This information is +// extracted and returned as IdentityDocumentFields, which records both the +// normalized field and value of the extracted text. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Textract's +// API operation AnalyzeID for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// An input parameter violated a constraint. For example, in synchronous operations, +// an InvalidParameterException exception occurs when neither of the S3Object +// or Bytes values are supplied in the Document request parameter. Validate +// your parameter before calling the API operation again. +// +// * InvalidS3ObjectException +// Amazon Textract is unable to access the S3 object that's specified in the +// request. for more information, Configure Access to Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html) +// For troubleshooting information, see Troubleshooting Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/troubleshooting.html) +// +// * UnsupportedDocumentException +// The format of the input document isn't supported. Documents for synchronous +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. +// +// * DocumentTooLargeException +// The document can't be processed because it's too large. The maximum document +// size for synchronous operations 10 MB. The maximum document size for asynchronous +// operations is 500 MB for PDF files. +// +// * BadDocumentException +// Amazon Textract isn't able to read the document. For more information on +// the document limits in Amazon Textract, see limits. +// +// * AccessDeniedException +// You aren't authorized to perform the action. Use the Amazon Resource Name +// (ARN) of an authorized user or IAM role to perform the operation. +// +// * ProvisionedThroughputExceededException +// The number of requests exceeded your throughput limit. If you want to increase +// this limit, contact Amazon Textract. +// +// * InternalServerError +// Amazon Textract experienced a service issue. Try your call again. +// +// * ThrottlingException +// Amazon Textract is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeID +func (c *Textract) AnalyzeID(input *AnalyzeIDInput) (*AnalyzeIDOutput, error) { + req, out := c.AnalyzeIDRequest(input) + return out, req.Send() +} + +// AnalyzeIDWithContext is the same as AnalyzeID with the addition of +// the ability to pass a context and additional request options. +// +// See AnalyzeID for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Textract) AnalyzeIDWithContext(ctx aws.Context, input *AnalyzeIDInput, opts ...request.Option) (*AnalyzeIDOutput, error) { + req, out := c.AnalyzeIDRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDetectDocumentText = "DetectDocumentText" // DetectDocumentTextRequest generates a "aws/request.Request" representing the @@ -367,8 +485,8 @@ func (c *Textract) DetectDocumentTextRequest(input *DetectDocumentTextInput) (re // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -916,8 +1034,8 @@ func (c *Textract) StartDocumentAnalysisRequest(input *StartDocumentAnalysisInpu // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -1063,8 +1181,8 @@ func (c *Textract) StartDocumentTextDetectionRequest(input *StartDocumentTextDet // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -1212,8 +1330,8 @@ func (c *Textract) StartExpenseAnalysisRequest(input *StartExpenseAnalysisInput) // // * UnsupportedDocumentException // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. // // * DocumentTooLargeException // The document can't be processed because it's too large. The maximum document @@ -1597,6 +1715,168 @@ func (s *AnalyzeExpenseOutput) SetExpenseDocuments(v []*ExpenseDocument) *Analyz return s } +// Used to contain the information detected by an AnalyzeID operation. +type AnalyzeIDDetections struct { + _ struct{} `type:"structure"` + + // The confidence score of the detected text. + Confidence *float64 `type:"float"` + + // Only returned for dates, returns the type of value detected and the date + // written in a more machine readable way. + NormalizedValue *NormalizedValue `type:"structure"` + + // Text of either the normalized field or value associated with it. + // + // Text is a required field + Text *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDDetections) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDDetections) GoString() string { + return s.String() +} + +// SetConfidence sets the Confidence field's value. +func (s *AnalyzeIDDetections) SetConfidence(v float64) *AnalyzeIDDetections { + s.Confidence = &v + return s +} + +// SetNormalizedValue sets the NormalizedValue field's value. +func (s *AnalyzeIDDetections) SetNormalizedValue(v *NormalizedValue) *AnalyzeIDDetections { + s.NormalizedValue = v + return s +} + +// SetText sets the Text field's value. +func (s *AnalyzeIDDetections) SetText(v string) *AnalyzeIDDetections { + s.Text = &v + return s +} + +type AnalyzeIDInput struct { + _ struct{} `type:"structure"` + + // The document being passed to AnalyzeID. + // + // DocumentPages is a required field + DocumentPages []*Document `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AnalyzeIDInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AnalyzeIDInput"} + if s.DocumentPages == nil { + invalidParams.Add(request.NewErrParamRequired("DocumentPages")) + } + if s.DocumentPages != nil && len(s.DocumentPages) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DocumentPages", 1)) + } + if s.DocumentPages != nil { + for i, v := range s.DocumentPages { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DocumentPages", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDocumentPages sets the DocumentPages field's value. +func (s *AnalyzeIDInput) SetDocumentPages(v []*Document) *AnalyzeIDInput { + s.DocumentPages = v + return s +} + +type AnalyzeIDOutput struct { + _ struct{} `type:"structure"` + + // The version of the AnalyzeIdentity API being used to process documents. + AnalyzeIDModelVersion *string `type:"string"` + + // Information about the input document. + DocumentMetadata *DocumentMetadata `type:"structure"` + + // The list of documents processed by AnalyzeID. Includes a number denoting + // their place in the list and the response structure for the document. + IdentityDocuments []*IdentityDocument `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AnalyzeIDOutput) GoString() string { + return s.String() +} + +// SetAnalyzeIDModelVersion sets the AnalyzeIDModelVersion field's value. +func (s *AnalyzeIDOutput) SetAnalyzeIDModelVersion(v string) *AnalyzeIDOutput { + s.AnalyzeIDModelVersion = &v + return s +} + +// SetDocumentMetadata sets the DocumentMetadata field's value. +func (s *AnalyzeIDOutput) SetDocumentMetadata(v *DocumentMetadata) *AnalyzeIDOutput { + s.DocumentMetadata = v + return s +} + +// SetIdentityDocuments sets the IdentityDocuments field's value. +func (s *AnalyzeIDOutput) SetIdentityDocuments(v []*IdentityDocument) *AnalyzeIDOutput { + s.IdentityDocuments = v + return s +} + // Amazon Textract isn't able to read the document. For more information on // the document limits in Amazon Textract, see limits. type BadDocumentException struct { @@ -2410,7 +2690,7 @@ func (s *ExpenseDocument) SetSummaryFields(v []*ExpenseField) *ExpenseDocument { return s } -// Breakdown of detected information, seperated into the catagories Type, LableDetection, +// Breakdown of detected information, seperated into the catagories Type, LabelDetection, // and ValueDetection type ExpenseField struct { _ struct{} `type:"structure"` @@ -3362,6 +3642,91 @@ func (s *IdempotentParameterMismatchException) RequestID() string { return s.RespMetadata.RequestID } +// The structure that lists each document processed in an AnalyzeID operation. +type IdentityDocument struct { + _ struct{} `type:"structure"` + + // Denotes the placement of a document in the IdentityDocument list. The first + // document is marked 1, the second 2 and so on. + DocumentIndex *int64 `type:"integer"` + + // The structure used to record information extracted from identity documents. + // Contains both normalized field and value of the extracted text. + IdentityDocumentFields []*IdentityDocumentField `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IdentityDocument) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IdentityDocument) GoString() string { + return s.String() +} + +// SetDocumentIndex sets the DocumentIndex field's value. +func (s *IdentityDocument) SetDocumentIndex(v int64) *IdentityDocument { + s.DocumentIndex = &v + return s +} + +// SetIdentityDocumentFields sets the IdentityDocumentFields field's value. +func (s *IdentityDocument) SetIdentityDocumentFields(v []*IdentityDocumentField) *IdentityDocument { + s.IdentityDocumentFields = v + return s +} + +// Structure containing both the normalized type of the extracted information +// and the text associated with it. These are extracted as Type and Value respectively. +type IdentityDocumentField struct { + _ struct{} `type:"structure"` + + // Used to contain the information detected by an AnalyzeID operation. + Type *AnalyzeIDDetections `type:"structure"` + + // Used to contain the information detected by an AnalyzeID operation. + ValueDetection *AnalyzeIDDetections `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IdentityDocumentField) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IdentityDocumentField) GoString() string { + return s.String() +} + +// SetType sets the Type field's value. +func (s *IdentityDocumentField) SetType(v *AnalyzeIDDetections) *IdentityDocumentField { + s.Type = v + return s +} + +// SetValueDetection sets the ValueDetection field's value. +func (s *IdentityDocumentField) SetValueDetection(v *AnalyzeIDDetections) *IdentityDocumentField { + s.ValueDetection = v + return s +} + // Amazon Textract experienced a service issue. Try your call again. type InternalServerError struct { _ struct{} `type:"structure"` @@ -3832,6 +4197,48 @@ func (s *LineItemGroup) SetLineItems(v []*LineItemFields) *LineItemGroup { return s } +// Contains information relating to dates in a document, including the type +// of value, and the value. +type NormalizedValue struct { + _ struct{} `type:"structure"` + + // The value of the date, written as Year-Month-DayTHour:Minute:Second. + Value *string `type:"string"` + + // The normalized type of the value detected. In this case, DATE. + ValueType *string `type:"string" enum:"ValueType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NormalizedValue) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NormalizedValue) GoString() string { + return s.String() +} + +// SetValue sets the Value field's value. +func (s *NormalizedValue) SetValue(v string) *NormalizedValue { + s.Value = &v + return s +} + +// SetValueType sets the ValueType field's value. +func (s *NormalizedValue) SetValueType(v string) *NormalizedValue { + s.ValueType = &v + return s +} + // The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon // Textract publishes the completion status of an asynchronous document operation, // such as StartDocumentTextDetection. @@ -4797,8 +5204,8 @@ func (s *ThrottlingException) RequestID() string { } // The format of the input document isn't supported. Documents for synchronous -// operations can be in PNG or JPEG format. Documents for asynchronous operations -// can also be in PDF format. +// operations can be in PNG or JPEG format only. Documents for asynchronous +// operations can be in PDF format. type UnsupportedDocumentException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5063,3 +5470,15 @@ func TextType_Values() []string { TextTypePrinted, } } + +const ( + // ValueTypeDate is a ValueType enum value + ValueTypeDate = "DATE" +) + +// ValueType_Values returns all elements of the ValueType enum +func ValueType_Values() []string { + return []string{ + ValueTypeDate, + } +} diff --git a/service/textract/errors.go b/service/textract/errors.go index cab57ba0da4..f71376e9c14 100644 --- a/service/textract/errors.go +++ b/service/textract/errors.go @@ -109,8 +109,8 @@ const ( // "UnsupportedDocumentException". // // The format of the input document isn't supported. Documents for synchronous - // operations can be in PNG or JPEG format. Documents for asynchronous operations - // can also be in PDF format. + // operations can be in PNG or JPEG format only. Documents for asynchronous + // operations can be in PDF format. ErrCodeUnsupportedDocumentException = "UnsupportedDocumentException" ) diff --git a/service/textract/textractiface/interface.go b/service/textract/textractiface/interface.go index 2d921d2abc2..96d7ec342e3 100644 --- a/service/textract/textractiface/interface.go +++ b/service/textract/textractiface/interface.go @@ -68,6 +68,10 @@ type TextractAPI interface { AnalyzeExpenseWithContext(aws.Context, *textract.AnalyzeExpenseInput, ...request.Option) (*textract.AnalyzeExpenseOutput, error) AnalyzeExpenseRequest(*textract.AnalyzeExpenseInput) (*request.Request, *textract.AnalyzeExpenseOutput) + AnalyzeID(*textract.AnalyzeIDInput) (*textract.AnalyzeIDOutput, error) + AnalyzeIDWithContext(aws.Context, *textract.AnalyzeIDInput, ...request.Option) (*textract.AnalyzeIDOutput, error) + AnalyzeIDRequest(*textract.AnalyzeIDInput) (*request.Request, *textract.AnalyzeIDOutput) + DetectDocumentText(*textract.DetectDocumentTextInput) (*textract.DetectDocumentTextOutput, error) DetectDocumentTextWithContext(aws.Context, *textract.DetectDocumentTextInput, ...request.Option) (*textract.DetectDocumentTextOutput, error) DetectDocumentTextRequest(*textract.DetectDocumentTextInput) (*request.Request, *textract.DetectDocumentTextOutput)