amazonka-migration-hub-refactor-spaces-2.0: Amazon Migration Hub Refactor Spaces SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MigrationHubReFactorSpaces.Lens

Description

 
Synopsis

Operations

CreateApplication

createApplication_apiGatewayProxy :: Lens' CreateApplication (Maybe ApiGatewayProxyInput) Source #

A wrapper object holding the API Gateway endpoint type and stage name for the proxy.

createApplication_clientToken :: Lens' CreateApplication (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #

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.

createApplication_environmentIdentifier :: Lens' CreateApplication Text Source #

The unique identifier of the environment.

createApplication_name :: Lens' CreateApplication Text Source #

The name to use for the application.

createApplication_proxyType :: Lens' CreateApplication ProxyType Source #

The proxy type of the proxy created within the application.

createApplication_vpcId :: Lens' CreateApplication Text Source #

The ID of the virtual private cloud (VPC).

createApplicationResponse_apiGatewayProxy :: Lens' CreateApplicationResponse (Maybe ApiGatewayProxyInput) Source #

A wrapper object holding the API Gateway endpoint type and stage name for the proxy.

createApplicationResponse_arn :: Lens' CreateApplicationResponse (Maybe Text) Source #

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.

createApplicationResponse_createdByAccountId :: Lens' CreateApplicationResponse (Maybe Text) Source #

The Amazon Web Services account ID of application creator.

createApplicationResponse_createdTime :: Lens' CreateApplicationResponse (Maybe UTCTime) Source #

A timestamp that indicates when the application is created.

createApplicationResponse_environmentId :: Lens' CreateApplicationResponse (Maybe Text) Source #

The ID of the environment in which the application is created.

createApplicationResponse_lastUpdatedTime :: Lens' CreateApplicationResponse (Maybe UTCTime) Source #

A timestamp that indicates when the application was last updated.

createApplicationResponse_ownerAccountId :: Lens' CreateApplicationResponse (Maybe Text) Source #

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

createApplicationResponse_proxyType :: Lens' CreateApplicationResponse (Maybe ProxyType) Source #

The proxy type of the proxy created within the application.

createApplicationResponse_tags :: Lens' CreateApplicationResponse (Maybe (HashMap Text Text)) Source #

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.

CreateEnvironment

createEnvironment_clientToken :: Lens' CreateEnvironment (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createEnvironment_description :: Lens' CreateEnvironment (Maybe Text) Source #

The description of the environment.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #

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_arn :: Lens' CreateEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the environment.

createEnvironmentResponse_createdTime :: Lens' CreateEnvironmentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment is created.

createEnvironmentResponse_lastUpdatedTime :: Lens' CreateEnvironmentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment was last updated.

createEnvironmentResponse_ownerAccountId :: Lens' CreateEnvironmentResponse (Maybe Text) Source #

The Amazon Web Services account ID of environment owner.

createEnvironmentResponse_tags :: Lens' CreateEnvironmentResponse (Maybe (HashMap Text Text)) Source #

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..

CreateRoute

createRoute_clientToken :: Lens' CreateRoute (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createRoute_defaultRoute :: Lens' CreateRoute (Maybe DefaultRouteInput) Source #

Configuration for the default route type.

createRoute_tags :: Lens' CreateRoute (Maybe (HashMap Text Text)) Source #

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..

createRoute_uriPathRoute :: Lens' CreateRoute (Maybe UriPathRouteInput) Source #

The configuration for the URI path route type.

createRoute_applicationIdentifier :: Lens' CreateRoute Text Source #

The ID of the application within which the route is being created.

createRoute_environmentIdentifier :: Lens' CreateRoute Text Source #

The ID of the environment in which the route is created.

createRoute_routeType :: Lens' CreateRoute RouteType Source #

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.

createRoute_serviceIdentifier :: Lens' CreateRoute Text Source #

The ID of the service in which the route is created. Traffic that matches this route is forwarded to this service.

createRouteResponse_applicationId :: Lens' CreateRouteResponse (Maybe Text) Source #

The ID of the application in which the route is created.

createRouteResponse_arn :: Lens' CreateRouteResponse (Maybe Text) Source #

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.

createRouteResponse_createdByAccountId :: Lens' CreateRouteResponse (Maybe Text) Source #

The Amazon Web Services account ID of the route creator.

createRouteResponse_createdTime :: Lens' CreateRouteResponse (Maybe UTCTime) Source #

A timestamp that indicates when the route is created.

createRouteResponse_lastUpdatedTime :: Lens' CreateRouteResponse (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

createRouteResponse_ownerAccountId :: Lens' CreateRouteResponse (Maybe Text) Source #

The Amazon Web Services account ID of the route owner.

createRouteResponse_routeId :: Lens' CreateRouteResponse (Maybe Text) Source #

The unique identifier of the route.

createRouteResponse_serviceId :: Lens' CreateRouteResponse (Maybe Text) Source #

The ID of service in which the route is created. Traffic that matches this route is forwarded to this service.

createRouteResponse_state :: Lens' CreateRouteResponse (Maybe RouteState) Source #

The current state of the route. Activation state only allows ACTIVE or INACTIVE as user inputs. FAILED is a route state that is system generated.

createRouteResponse_tags :: Lens' CreateRouteResponse (Maybe (HashMap Text Text)) Source #

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.

CreateService

createService_clientToken :: Lens' CreateService (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createService_description :: Lens' CreateService (Maybe Text) Source #

The description of the service.

createService_lambdaEndpoint :: Lens' CreateService (Maybe LambdaEndpointInput) Source #

The configuration for the Lambda endpoint type.

createService_tags :: Lens' CreateService (Maybe (HashMap Text Text)) Source #

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..

createService_urlEndpoint :: Lens' CreateService (Maybe UrlEndpointInput) Source #

The configuration for the URL endpoint type. When creating a route to a service, Refactor Spaces automatically resolves the address in the UrlEndpointInput object URL when the Domain Name System (DNS) time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60 seconds.

createService_applicationIdentifier :: Lens' CreateService Text Source #

The ID of the application which the service is created.

createService_endpointType :: Lens' CreateService ServiceEndpointType Source #

The type of endpoint to use for the service. The type can be a URL in a VPC or an Lambda function.

createService_environmentIdentifier :: Lens' CreateService Text Source #

The ID of the environment in which the service is created.

createService_name :: Lens' CreateService Text Source #

The name of the service.

createServiceResponse_applicationId :: Lens' CreateServiceResponse (Maybe Text) Source #

The ID of the application that the created service belongs to.

createServiceResponse_arn :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service.

createServiceResponse_createdByAccountId :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service creator.

createServiceResponse_createdTime :: Lens' CreateServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service is created.

createServiceResponse_description :: Lens' CreateServiceResponse (Maybe Text) Source #

The description of the created service.

createServiceResponse_environmentId :: Lens' CreateServiceResponse (Maybe Text) Source #

The unique identifier of the environment.

createServiceResponse_lastUpdatedTime :: Lens' CreateServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service was last updated.

createServiceResponse_ownerAccountId :: Lens' CreateServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service owner.

createServiceResponse_tags :: Lens' CreateServiceResponse (Maybe (HashMap Text Text)) Source #

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..

DeleteApplication

deleteApplicationResponse_arn :: Lens' DeleteApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application.

deleteApplicationResponse_environmentId :: Lens' DeleteApplicationResponse (Maybe Text) Source #

The unique identifier of the application’s environment.

deleteApplicationResponse_lastUpdatedTime :: Lens' DeleteApplicationResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment was last updated.

DeleteEnvironment

deleteEnvironmentResponse_arn :: Lens' DeleteEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the environment.

deleteEnvironmentResponse_lastUpdatedTime :: Lens' DeleteEnvironmentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment was last updated.

DeleteResourcePolicy

deleteResourcePolicy_identifier :: Lens' DeleteResourcePolicy Text Source #

Amazon Resource Name (ARN) of the resource associated with the policy.

DeleteRoute

deleteRoute_applicationIdentifier :: Lens' DeleteRoute Text Source #

The ID of the application to delete the route from.

deleteRoute_environmentIdentifier :: Lens' DeleteRoute Text Source #

The ID of the environment to delete the route from.

deleteRoute_routeIdentifier :: Lens' DeleteRoute Text Source #

The ID of the route to delete.

deleteRouteResponse_applicationId :: Lens' DeleteRouteResponse (Maybe Text) Source #

The ID of the application that the route belongs to.

deleteRouteResponse_arn :: Lens' DeleteRouteResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the route.

deleteRouteResponse_lastUpdatedTime :: Lens' DeleteRouteResponse (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

deleteRouteResponse_serviceId :: Lens' DeleteRouteResponse (Maybe Text) Source #

The ID of the service that the route belongs to.

DeleteService

deleteService_applicationIdentifier :: Lens' DeleteService Text Source #

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.

deleteService_environmentIdentifier :: Lens' DeleteService Text Source #

The ID of the environment that the service is in.

deleteService_serviceIdentifier :: Lens' DeleteService Text Source #

The ID of the service to delete.

deleteServiceResponse_applicationId :: Lens' DeleteServiceResponse (Maybe Text) Source #

The ID of the application that the service is in.

deleteServiceResponse_arn :: Lens' DeleteServiceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service.

deleteServiceResponse_environmentId :: Lens' DeleteServiceResponse (Maybe Text) Source #

The unique identifier of the environment.

deleteServiceResponse_lastUpdatedTime :: Lens' DeleteServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service was last updated.

GetApplication

getApplicationResponse_arn :: Lens' GetApplicationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application.

getApplicationResponse_createdByAccountId :: Lens' GetApplicationResponse (Maybe Text) Source #

The Amazon Web Services account ID of the application creator.

getApplicationResponse_createdTime :: Lens' GetApplicationResponse (Maybe UTCTime) Source #

A timestamp that indicates when the application is created.

getApplicationResponse_error :: Lens' GetApplicationResponse (Maybe ErrorResponse) Source #

Any error associated with the application resource.

getApplicationResponse_lastUpdatedTime :: Lens' GetApplicationResponse (Maybe UTCTime) Source #

A timestamp that indicates when the application was last updated.

getApplicationResponse_ownerAccountId :: Lens' GetApplicationResponse (Maybe Text) Source #

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

getApplicationResponse_proxyType :: Lens' GetApplicationResponse (Maybe ProxyType) Source #

The proxy type of the proxy created within the application.

getApplicationResponse_tags :: Lens' GetApplicationResponse (Maybe (HashMap Text Text)) Source #

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.

getApplicationResponse_vpcId :: Lens' GetApplicationResponse (Maybe Text) Source #

The ID of the virtual private cloud (VPC).

GetEnvironment

getEnvironmentResponse_arn :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the environment.

getEnvironmentResponse_createdTime :: Lens' GetEnvironmentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment is created.

getEnvironmentResponse_error :: Lens' GetEnvironmentResponse (Maybe ErrorResponse) Source #

Any error associated with the environment resource.

getEnvironmentResponse_lastUpdatedTime :: Lens' GetEnvironmentResponse (Maybe UTCTime) Source #

A timestamp that indicates when the environment was last updated.

getEnvironmentResponse_ownerAccountId :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The Amazon Web Services account ID of the environment owner.

getEnvironmentResponse_tags :: Lens' GetEnvironmentResponse (Maybe (HashMap Text Text)) Source #

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.

getEnvironmentResponse_transitGatewayId :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The ID of the transit gateway set up by the environment.

GetResourcePolicy

getResourcePolicy_identifier :: Lens' GetResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the resource associated with the policy.

getResourcePolicyResponse_policy :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

A JSON-formatted string for an Amazon Web Services resource-based policy.

GetRoute

getRouteResponse_applicationId :: Lens' GetRouteResponse (Maybe Text) Source #

The ID of the application that the route belongs to.

getRouteResponse_arn :: Lens' GetRouteResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the route.

getRouteResponse_createdByAccountId :: Lens' GetRouteResponse (Maybe Text) Source #

The Amazon Web Services account ID of the route creator.

getRouteResponse_createdTime :: Lens' GetRouteResponse (Maybe UTCTime) Source #

The timestamp of when the route is created.

getRouteResponse_environmentId :: Lens' GetRouteResponse (Maybe Text) Source #

Unique identifier of the environment.

getRouteResponse_error :: Lens' GetRouteResponse (Maybe ErrorResponse) Source #

Any error associated with the route resource.

getRouteResponse_includeChildPaths :: Lens' GetRouteResponse (Maybe Bool) Source #

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.

getRouteResponse_lastUpdatedTime :: Lens' GetRouteResponse (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

getRouteResponse_methods :: Lens' GetRouteResponse (Maybe [HttpMethod]) Source #

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.

getRouteResponse_ownerAccountId :: Lens' GetRouteResponse (Maybe Text) Source #

The Amazon Web Services account ID of the route owner.

getRouteResponse_pathResourceToId :: Lens' GetRouteResponse (Maybe (HashMap Text Text)) Source #

A mapping of Amazon API Gateway path resources to resource IDs.

getRouteResponse_routeId :: Lens' GetRouteResponse (Maybe Text) Source #

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.

getRouteResponse_serviceId :: Lens' GetRouteResponse (Maybe Text) Source #

The unique identifier of the service.

getRouteResponse_sourcePath :: Lens' GetRouteResponse (Maybe Text) Source #

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

getRouteResponse_tags :: Lens' GetRouteResponse (Maybe (HashMap Text Text)) Source #

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.

getRouteResponse_httpStatus :: Lens' GetRouteResponse Int Source #

The response's http status code.

GetService

getServiceResponse_arn :: Lens' GetServiceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service.

getServiceResponse_createdByAccountId :: Lens' GetServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service creator.

getServiceResponse_createdTime :: Lens' GetServiceResponse (Maybe UTCTime) Source #

The timestamp of when the service is created.

getServiceResponse_environmentId :: Lens' GetServiceResponse (Maybe Text) Source #

The unique identifier of the environment.

getServiceResponse_error :: Lens' GetServiceResponse (Maybe ErrorResponse) Source #

Any error associated with the service resource.

getServiceResponse_lambdaEndpoint :: Lens' GetServiceResponse (Maybe LambdaEndpointConfig) Source #

The configuration for the Lambda endpoint type.

The Arn is the Amazon Resource Name (ARN) of the Lambda function associated with this service.

getServiceResponse_lastUpdatedTime :: Lens' GetServiceResponse (Maybe UTCTime) Source #

A timestamp that indicates when the service was last updated.

getServiceResponse_ownerAccountId :: Lens' GetServiceResponse (Maybe Text) Source #

The Amazon Web Services account ID of the service owner.

getServiceResponse_serviceId :: Lens' GetServiceResponse (Maybe Text) Source #

The unique identifier of the service.

getServiceResponse_tags :: Lens' GetServiceResponse (Maybe (HashMap Text Text)) Source #

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.

getServiceResponse_urlEndpoint :: Lens' GetServiceResponse (Maybe UrlEndpointConfig) Source #

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.

getServiceResponse_vpcId :: Lens' GetServiceResponse (Maybe Text) Source #

The ID of the virtual private cloud (VPC).

ListApplications

listApplications_maxResults :: Lens' ListApplications (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

The token for the next page of results.

ListEnvironmentVpcs

listEnvironmentVpcs_maxResults :: Lens' ListEnvironmentVpcs (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listEnvironmentVpcs_nextToken :: Lens' ListEnvironmentVpcs (Maybe Text) Source #

The token for the next page of results.

ListEnvironments

listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #

The token for the next page of results.

ListRoutes

listRoutes_maxResults :: Lens' ListRoutes (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listRoutes_nextToken :: Lens' ListRoutes (Maybe Text) Source #

The token for the next page of results.

listRoutesResponse_nextToken :: Lens' ListRoutesResponse (Maybe Text) Source #

The token for the next page of results.

ListServices

listServices_maxResults :: Lens' ListServices (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listServices_nextToken :: Lens' ListServices (Maybe Text) Source #

The token for the next page of results.

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #

The token for the next page of results.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource.

PutResourcePolicy

putResourcePolicy_policy :: Lens' PutResourcePolicy Text Source #

A JSON-formatted string for an Amazon Web Services resource-based policy.

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text Source #

The Amazon Resource Name (ARN) of the resource to which the policy is being attached.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

The new or modified tags for the resource.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of keys of the tags to be removed from the resource.

UpdateRoute

updateRoute_activationState :: Lens' UpdateRoute RouteActivationState Source #

If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.

updateRoute_applicationIdentifier :: Lens' UpdateRoute Text Source #

The ID of the application within which the route is being updated.

updateRoute_environmentIdentifier :: Lens' UpdateRoute Text Source #

The ID of the environment in which the route is being updated.

updateRoute_routeIdentifier :: Lens' UpdateRoute Text Source #

The unique identifier of the route to update.

updateRouteResponse_applicationId :: Lens' UpdateRouteResponse (Maybe Text) Source #

The ID of the application in which the route is being updated.

updateRouteResponse_arn :: Lens' UpdateRouteResponse (Maybe Text) Source #

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.

updateRouteResponse_lastUpdatedTime :: Lens' UpdateRouteResponse (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

updateRouteResponse_routeId :: Lens' UpdateRouteResponse (Maybe Text) Source #

The unique identifier of the route.

updateRouteResponse_serviceId :: Lens' UpdateRouteResponse (Maybe Text) Source #

The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.

Types

ApiGatewayProxyConfig

apiGatewayProxyConfig_apiGatewayId :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The resource ID of the API Gateway for the proxy.

apiGatewayProxyConfig_nlbArn :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

apiGatewayProxyConfig_nlbName :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The name of the Network Load Balancer that is configured by the API Gateway proxy.

apiGatewayProxyConfig_proxyUrl :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The endpoint URL of the API Gateway proxy.

apiGatewayProxyConfig_stageName :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The name of the API Gateway stage. The name defaults to prod.

apiGatewayProxyConfig_vpcLinkId :: Lens' ApiGatewayProxyConfig (Maybe Text) Source #

The VpcLink ID of the API Gateway proxy.

ApiGatewayProxyInput

apiGatewayProxyInput_endpointType :: Lens' ApiGatewayProxyInput (Maybe ApiGatewayEndpointType) Source #

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.

apiGatewayProxyInput_stageName :: Lens' ApiGatewayProxyInput (Maybe Text) Source #

The name of the API Gateway stage. The name defaults to prod.

ApiGatewayProxySummary

apiGatewayProxySummary_apiGatewayId :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The resource ID of the API Gateway for the proxy.

apiGatewayProxySummary_nlbArn :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

apiGatewayProxySummary_nlbName :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The name of the Network Load Balancer that is configured by the API Gateway proxy.

apiGatewayProxySummary_proxyUrl :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The endpoint URL of the API Gateway proxy.

apiGatewayProxySummary_stageName :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The name of the API Gateway stage. The name defaults to prod.

apiGatewayProxySummary_vpcLinkId :: Lens' ApiGatewayProxySummary (Maybe Text) Source #

The VpcLink ID of the API Gateway proxy.

ApplicationSummary

applicationSummary_applicationId :: Lens' ApplicationSummary (Maybe Text) Source #

The unique identifier of the application.

applicationSummary_arn :: Lens' ApplicationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the application.

applicationSummary_createdByAccountId :: Lens' ApplicationSummary (Maybe Text) Source #

The Amazon Web Services account ID of the application creator.

applicationSummary_createdTime :: Lens' ApplicationSummary (Maybe UTCTime) Source #

A timestamp that indicates when the application is created.

applicationSummary_environmentId :: Lens' ApplicationSummary (Maybe Text) Source #

The unique identifier of the environment.

applicationSummary_error :: Lens' ApplicationSummary (Maybe ErrorResponse) Source #

Any error associated with the application resource.

applicationSummary_lastUpdatedTime :: Lens' ApplicationSummary (Maybe UTCTime) Source #

A timestamp that indicates when the application was last updated.

applicationSummary_ownerAccountId :: Lens' ApplicationSummary (Maybe Text) Source #

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

applicationSummary_proxyType :: Lens' ApplicationSummary (Maybe ProxyType) Source #

The proxy type of the proxy created within the application.

applicationSummary_tags :: Lens' ApplicationSummary (Maybe (HashMap Text Text)) Source #

The tags assigned to the application.

applicationSummary_vpcId :: Lens' ApplicationSummary (Maybe Text) Source #

The ID of the virtual private cloud (VPC).

DefaultRouteInput

defaultRouteInput_activationState :: Lens' DefaultRouteInput (Maybe RouteActivationState) Source #

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

EnvironmentSummary

environmentSummary_arn :: Lens' EnvironmentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the environment.

environmentSummary_createdTime :: Lens' EnvironmentSummary (Maybe UTCTime) Source #

A timestamp that indicates when the environment is created.

environmentSummary_environmentId :: Lens' EnvironmentSummary (Maybe Text) Source #

The unique identifier of the environment.

environmentSummary_error :: Lens' EnvironmentSummary (Maybe ErrorResponse) Source #

Any error associated with the environment resource.

environmentSummary_lastUpdatedTime :: Lens' EnvironmentSummary (Maybe UTCTime) Source #

A timestamp that indicates when the environment was last updated.

environmentSummary_ownerAccountId :: Lens' EnvironmentSummary (Maybe Text) Source #

The Amazon Web Services account ID of the environment owner.

environmentSummary_tags :: Lens' EnvironmentSummary (Maybe (HashMap Text Text)) Source #

The tags assigned to the environment.

environmentSummary_transitGatewayId :: Lens' EnvironmentSummary (Maybe Text) Source #

The ID of the transit gateway set up by the environment.

EnvironmentVpc

environmentVpc_accountId :: Lens' EnvironmentVpc (Maybe Text) Source #

The Amazon Web Services account ID of the virtual private cloud (VPC) owner.

environmentVpc_cidrBlocks :: Lens' EnvironmentVpc (Maybe (NonEmpty Text)) Source #

The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.

environmentVpc_createdTime :: Lens' EnvironmentVpc (Maybe UTCTime) Source #

A timestamp that indicates when the VPC is first added to the environment.

environmentVpc_environmentId :: Lens' EnvironmentVpc (Maybe Text) Source #

The unique identifier of the environment.

environmentVpc_lastUpdatedTime :: Lens' EnvironmentVpc (Maybe UTCTime) Source #

A timestamp that indicates when the VPC was last updated by the environment.

environmentVpc_vpcName :: Lens' EnvironmentVpc (Maybe Text) Source #

The name of the VPC at the time it is added to the environment.

ErrorResponse

errorResponse_accountId :: Lens' ErrorResponse (Maybe Text) Source #

The Amazon Web Services account ID of the resource owner.

errorResponse_code :: Lens' ErrorResponse (Maybe ErrorCode) Source #

The error code associated with the error.

errorResponse_message :: Lens' ErrorResponse (Maybe Text) Source #

The message associated with the error.

LambdaEndpointConfig

lambdaEndpointConfig_arn :: Lens' LambdaEndpointConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Lambda endpoint.

LambdaEndpointInput

lambdaEndpointInput_arn :: Lens' LambdaEndpointInput Text Source #

The Amazon Resource Name (ARN) of the Lambda function or alias.

LambdaEndpointSummary

lambdaEndpointSummary_arn :: Lens' LambdaEndpointSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Lambda endpoint.

RouteSummary

routeSummary_applicationId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the application.

routeSummary_arn :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the route.

routeSummary_createdByAccountId :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Web Services account ID of the route creator.

routeSummary_createdTime :: Lens' RouteSummary (Maybe UTCTime) Source #

A timestamp that indicates when the route is created.

routeSummary_environmentId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the environment.

routeSummary_error :: Lens' RouteSummary (Maybe ErrorResponse) Source #

Any error associated with the route resource.

routeSummary_includeChildPaths :: Lens' RouteSummary (Maybe Bool) Source #

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.

routeSummary_lastUpdatedTime :: Lens' RouteSummary (Maybe UTCTime) Source #

A timestamp that indicates when the route was last updated.

routeSummary_methods :: Lens' RouteSummary (Maybe [HttpMethod]) Source #

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_ownerAccountId :: Lens' RouteSummary (Maybe Text) Source #

The Amazon Web Services account ID of the route owner.

routeSummary_pathResourceToId :: Lens' RouteSummary (Maybe (HashMap Text Text)) Source #

A mapping of Amazon API Gateway path resources to resource IDs.

routeSummary_routeId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the route.

routeSummary_serviceId :: Lens' RouteSummary (Maybe Text) Source #

The unique identifier of the service.

routeSummary_sourcePath :: Lens' RouteSummary (Maybe Text) Source #

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

routeSummary_state :: Lens' RouteSummary (Maybe RouteState) Source #

The current state of the route.

routeSummary_tags :: Lens' RouteSummary (Maybe (HashMap Text Text)) Source #

The tags assigned to the route.

ServiceSummary

serviceSummary_applicationId :: Lens' ServiceSummary (Maybe Text) Source #

The unique identifier of the application.

serviceSummary_arn :: Lens' ServiceSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service.

serviceSummary_createdByAccountId :: Lens' ServiceSummary (Maybe Text) Source #

The Amazon Web Services account ID of the service creator.

serviceSummary_createdTime :: Lens' ServiceSummary (Maybe UTCTime) Source #

A timestamp that indicates when the service is created.

serviceSummary_environmentId :: Lens' ServiceSummary (Maybe Text) Source #

The unique identifier of the environment.

serviceSummary_error :: Lens' ServiceSummary (Maybe ErrorResponse) Source #

Any error associated with the service resource.

serviceSummary_lambdaEndpoint :: Lens' ServiceSummary (Maybe LambdaEndpointSummary) Source #

A summary of the configuration for the Lambda endpoint type.

serviceSummary_lastUpdatedTime :: Lens' ServiceSummary (Maybe UTCTime) Source #

A timestamp that indicates when the service was last updated.

serviceSummary_ownerAccountId :: Lens' ServiceSummary (Maybe Text) Source #

The Amazon Web Services account ID of the service owner.

serviceSummary_serviceId :: Lens' ServiceSummary (Maybe Text) Source #

The unique identifier of the service.

serviceSummary_state :: Lens' ServiceSummary (Maybe ServiceState) Source #

The current state of the service.

serviceSummary_tags :: Lens' ServiceSummary (Maybe (HashMap Text Text)) Source #

The tags assigned to the service.

serviceSummary_urlEndpoint :: Lens' ServiceSummary (Maybe UrlEndpointSummary) Source #

The summary of the configuration for the URL endpoint type.

serviceSummary_vpcId :: Lens' ServiceSummary (Maybe Text) Source #

The ID of the virtual private cloud (VPC).

UriPathRouteInput

uriPathRouteInput_includeChildPaths :: Lens' UriPathRouteInput (Maybe Bool) Source #

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.

uriPathRouteInput_methods :: Lens' UriPathRouteInput (Maybe [HttpMethod]) Source #

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_activationState :: Lens' UriPathRouteInput RouteActivationState Source #

If set to ACTIVE, traffic is forwarded to this route’s service after the route is created.

uriPathRouteInput_sourcePath :: Lens' UriPathRouteInput Text Source #

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

UrlEndpointConfig

urlEndpointConfig_healthUrl :: Lens' UrlEndpointConfig (Maybe Text) Source #

The health check URL of the URL endpoint type.

UrlEndpointInput

urlEndpointInput_healthUrl :: Lens' UrlEndpointInput (Maybe Text) Source #

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.

urlEndpointInput_url :: Lens' UrlEndpointInput Text Source #

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.

UrlEndpointSummary

urlEndpointSummary_healthUrl :: Lens' UrlEndpointSummary (Maybe Text) Source #

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.

urlEndpointSummary_url :: Lens' UrlEndpointSummary (Maybe Text) Source #

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.