Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateApplication
- CreateEnvironment
- CreateRoute
- CreateService
- DeleteApplication
- DeleteEnvironment
- DeleteResourcePolicy
- DeleteRoute
- DeleteService
- GetApplication
- GetEnvironment
- GetResourcePolicy
- GetRoute
- GetService
- ListApplications (Paginated)
- ListEnvironmentVpcs (Paginated)
- ListEnvironments (Paginated)
- ListRoutes (Paginated)
- ListServices (Paginated)
- ListTagsForResource
- PutResourcePolicy
- TagResource
- UntagResource
- UpdateRoute
- Types
- ApiGatewayEndpointType
- ApplicationState
- EnvironmentState
- ErrorCode
- ErrorResourceType
- HttpMethod
- NetworkFabricType
- ProxyType
- RouteActivationState
- RouteState
- RouteType
- ServiceEndpointType
- ServiceState
- ApiGatewayProxyConfig
- ApiGatewayProxyInput
- ApiGatewayProxySummary
- ApplicationSummary
- DefaultRouteInput
- EnvironmentSummary
- EnvironmentVpc
- ErrorResponse
- LambdaEndpointConfig
- LambdaEndpointInput
- LambdaEndpointSummary
- RouteSummary
- ServiceSummary
- UriPathRouteInput
- UrlEndpointConfig
- UrlEndpointInput
- UrlEndpointSummary
Derived from API version 2021-10-26
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services 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.
To share Refactor Spaces environments with other Amazon Web Services
accounts or with Organizations and their OUs, use Resource Access
Manager's CreateResourceShare
API. See
CreateResourceShare
in the Amazon Web Services RAM API Reference.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidResourcePolicyException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateApplication = CreateApplication' (Maybe ApiGatewayProxyInput) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Text Text ProxyType Text
- newCreateApplication :: Text -> Text -> ProxyType -> Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' (Maybe ApiGatewayProxyInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- data CreateEnvironment = CreateEnvironment' (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Text NetworkFabricType
- newCreateEnvironment :: Text -> NetworkFabricType -> CreateEnvironment
- data CreateEnvironmentResponse = CreateEnvironmentResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) Int
- newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
- data CreateRoute = CreateRoute' (Maybe Text) (Maybe DefaultRouteInput) (Maybe (Sensitive (HashMap Text Text))) (Maybe UriPathRouteInput) Text Text RouteType Text
- newCreateRoute :: Text -> Text -> RouteType -> Text -> CreateRoute
- data CreateRouteResponse = CreateRouteResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UriPathRouteInput) Int
- newCreateRouteResponse :: Int -> CreateRouteResponse
- data CreateService = CreateService' (Maybe Text) (Maybe Text) (Maybe LambdaEndpointInput) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointInput) (Maybe Text) Text ServiceEndpointType Text Text
- newCreateService :: Text -> ServiceEndpointType -> Text -> Text -> CreateService
- data CreateServiceResponse = CreateServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe LambdaEndpointInput) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointInput) (Maybe Text) Int
- newCreateServiceResponse :: Int -> CreateServiceResponse
- data DeleteApplication = DeleteApplication' Text Text
- newDeleteApplication :: Text -> Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ApplicationState) Int
- newDeleteApplicationResponse :: Int -> DeleteApplicationResponse
- data DeleteEnvironment = DeleteEnvironment' Text
- newDeleteEnvironment :: Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EnvironmentState) Int
- newDeleteEnvironmentResponse :: Int -> DeleteEnvironmentResponse
- data DeleteResourcePolicy = DeleteResourcePolicy' Text
- newDeleteResourcePolicy :: Text -> DeleteResourcePolicy
- data DeleteResourcePolicyResponse = DeleteResourcePolicyResponse' Int
- newDeleteResourcePolicyResponse :: Int -> DeleteResourcePolicyResponse
- data DeleteRoute = DeleteRoute' Text Text Text
- newDeleteRoute :: Text -> Text -> Text -> DeleteRoute
- data DeleteRouteResponse = DeleteRouteResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteState) Int
- newDeleteRouteResponse :: Int -> DeleteRouteResponse
- data DeleteService = DeleteService' Text Text Text
- newDeleteService :: Text -> Text -> Text -> DeleteService
- data DeleteServiceResponse = DeleteServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ServiceState) Int
- newDeleteServiceResponse :: Int -> DeleteServiceResponse
- data GetApplication = GetApplication' Text Text
- newGetApplication :: Text -> Text -> GetApplication
- data GetApplicationResponse = GetApplicationResponse' (Maybe ApiGatewayProxyConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int
- newGetApplicationResponse :: Int -> GetApplicationResponse
- data GetEnvironment = GetEnvironment' Text
- newGetEnvironment :: Text -> GetEnvironment
- data GetEnvironmentResponse = GetEnvironmentResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int
- newGetEnvironmentResponse :: Int -> GetEnvironmentResponse
- data GetResourcePolicy = GetResourcePolicy' Text
- newGetResourcePolicy :: Text -> GetResourcePolicy
- data GetResourcePolicyResponse = GetResourcePolicyResponse' (Maybe Text) Int
- newGetResourcePolicyResponse :: Int -> GetResourcePolicyResponse
- data GetRoute = GetRoute' Text Text Text
- newGetRoute :: Text -> Text -> Text -> GetRoute
- data GetRouteResponse = GetRouteResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe Bool) (Maybe POSIX) (Maybe [HttpMethod]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text))) Int
- newGetRouteResponse :: Int -> GetRouteResponse
- data GetService = GetService' Text Text Text
- newGetService :: Text -> Text -> Text -> GetService
- data GetServiceResponse = GetServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe ErrorResponse) (Maybe LambdaEndpointConfig) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointConfig) (Maybe Text) Int
- newGetServiceResponse :: Int -> GetServiceResponse
- data ListApplications = ListApplications' (Maybe Natural) (Maybe Text) Text
- newListApplications :: Text -> ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' (Maybe [ApplicationSummary]) (Maybe Text) Int
- newListApplicationsResponse :: Int -> ListApplicationsResponse
- data ListEnvironmentVpcs = ListEnvironmentVpcs' (Maybe Natural) (Maybe Text) Text
- newListEnvironmentVpcs :: Text -> ListEnvironmentVpcs
- data ListEnvironmentVpcsResponse = ListEnvironmentVpcsResponse' (Maybe [EnvironmentVpc]) (Maybe Text) Int
- newListEnvironmentVpcsResponse :: Int -> ListEnvironmentVpcsResponse
- data ListEnvironments = ListEnvironments' (Maybe Natural) (Maybe Text)
- newListEnvironments :: ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe [EnvironmentSummary]) (Maybe Text) Int
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data ListRoutes = ListRoutes' (Maybe Natural) (Maybe Text) Text Text
- newListRoutes :: Text -> Text -> ListRoutes
- data ListRoutesResponse = ListRoutesResponse' (Maybe Text) (Maybe [RouteSummary]) Int
- newListRoutesResponse :: Int -> ListRoutesResponse
- data ListServices = ListServices' (Maybe Natural) (Maybe Text) Text Text
- newListServices :: Text -> Text -> ListServices
- data ListServicesResponse = ListServicesResponse' (Maybe Text) (Maybe [ServiceSummary]) Int
- newListServicesResponse :: Int -> ListServicesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (Sensitive (HashMap Text Text))) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PutResourcePolicy = PutResourcePolicy' Text Text
- newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
- data PutResourcePolicyResponse = PutResourcePolicyResponse' Int
- newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
- data TagResource = TagResource' Text (Sensitive (HashMap Text Text))
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (Sensitive [Text])
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateRoute = UpdateRoute' RouteActivationState Text Text Text
- newUpdateRoute :: RouteActivationState -> Text -> Text -> Text -> UpdateRoute
- data UpdateRouteResponse = UpdateRouteResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteState) Int
- newUpdateRouteResponse :: Int -> UpdateRouteResponse
- newtype ApiGatewayEndpointType where
- newtype ApplicationState where
- ApplicationState' { }
- pattern ApplicationState_ACTIVE :: ApplicationState
- pattern ApplicationState_CREATING :: ApplicationState
- pattern ApplicationState_DELETING :: ApplicationState
- pattern ApplicationState_FAILED :: ApplicationState
- pattern ApplicationState_UPDATING :: ApplicationState
- newtype EnvironmentState where
- EnvironmentState' { }
- pattern EnvironmentState_ACTIVE :: EnvironmentState
- pattern EnvironmentState_CREATING :: EnvironmentState
- pattern EnvironmentState_DELETING :: EnvironmentState
- pattern EnvironmentState_FAILED :: EnvironmentState
- newtype ErrorCode where
- ErrorCode' { }
- pattern ErrorCode_INVALID_RESOURCE_STATE :: ErrorCode
- pattern ErrorCode_NOT_AUTHORIZED :: ErrorCode
- pattern ErrorCode_REQUEST_LIMIT_EXCEEDED :: ErrorCode
- pattern ErrorCode_RESOURCE_CREATION_FAILURE :: ErrorCode
- pattern ErrorCode_RESOURCE_DELETION_FAILURE :: ErrorCode
- pattern ErrorCode_RESOURCE_IN_USE :: ErrorCode
- pattern ErrorCode_RESOURCE_LIMIT_EXCEEDED :: ErrorCode
- pattern ErrorCode_RESOURCE_NOT_FOUND :: ErrorCode
- pattern ErrorCode_RESOURCE_RETRIEVAL_FAILURE :: ErrorCode
- pattern ErrorCode_RESOURCE_UPDATE_FAILURE :: ErrorCode
- pattern ErrorCode_SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE :: ErrorCode
- pattern ErrorCode_STATE_TRANSITION_FAILURE :: ErrorCode
- newtype ErrorResourceType where
- ErrorResourceType' { }
- pattern ErrorResourceType_API_GATEWAY :: ErrorResourceType
- pattern ErrorResourceType_APPLICATION :: ErrorResourceType
- pattern ErrorResourceType_ENVIRONMENT :: ErrorResourceType
- pattern ErrorResourceType_IAM_ROLE :: ErrorResourceType
- pattern ErrorResourceType_LAMBDA :: ErrorResourceType
- pattern ErrorResourceType_LOAD_BALANCER_LISTENER :: ErrorResourceType
- pattern ErrorResourceType_NLB :: ErrorResourceType
- pattern ErrorResourceType_RESOURCE_SHARE :: ErrorResourceType
- pattern ErrorResourceType_ROUTE :: ErrorResourceType
- pattern ErrorResourceType_ROUTE_TABLE :: ErrorResourceType
- pattern ErrorResourceType_SECURITY_GROUP :: ErrorResourceType
- pattern ErrorResourceType_SERVICE :: ErrorResourceType
- pattern ErrorResourceType_SUBNET :: ErrorResourceType
- pattern ErrorResourceType_TARGET_GROUP :: ErrorResourceType
- pattern ErrorResourceType_TRANSIT_GATEWAY :: ErrorResourceType
- pattern ErrorResourceType_TRANSIT_GATEWAY_ATTACHMENT :: ErrorResourceType
- pattern ErrorResourceType_VPC :: ErrorResourceType
- pattern ErrorResourceType_VPC_ENDPOINT_SERVICE_CONFIGURATION :: ErrorResourceType
- pattern ErrorResourceType_VPC_LINK :: ErrorResourceType
- newtype HttpMethod where
- HttpMethod' { }
- pattern HttpMethod_DELETE :: HttpMethod
- pattern HttpMethod_GET :: HttpMethod
- pattern HttpMethod_HEAD :: HttpMethod
- pattern HttpMethod_OPTIONS :: HttpMethod
- pattern HttpMethod_PATCH :: HttpMethod
- pattern HttpMethod_POST :: HttpMethod
- pattern HttpMethod_PUT :: HttpMethod
- newtype NetworkFabricType where
- newtype ProxyType where
- ProxyType' { }
- pattern ProxyType_API_GATEWAY :: ProxyType
- newtype RouteActivationState where
- newtype RouteState where
- RouteState' { }
- pattern RouteState_ACTIVE :: RouteState
- pattern RouteState_CREATING :: RouteState
- pattern RouteState_DELETING :: RouteState
- pattern RouteState_FAILED :: RouteState
- pattern RouteState_INACTIVE :: RouteState
- pattern RouteState_UPDATING :: RouteState
- newtype RouteType where
- RouteType' { }
- pattern RouteType_DEFAULT :: RouteType
- pattern RouteType_URI_PATH :: RouteType
- newtype ServiceEndpointType where
- newtype ServiceState where
- ServiceState' { }
- pattern ServiceState_ACTIVE :: ServiceState
- pattern ServiceState_CREATING :: ServiceState
- pattern ServiceState_DELETING :: ServiceState
- pattern ServiceState_FAILED :: ServiceState
- data ApiGatewayProxyConfig = ApiGatewayProxyConfig' (Maybe Text) (Maybe ApiGatewayEndpointType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newApiGatewayProxyConfig :: ApiGatewayProxyConfig
- data ApiGatewayProxyInput = ApiGatewayProxyInput' (Maybe ApiGatewayEndpointType) (Maybe Text)
- newApiGatewayProxyInput :: ApiGatewayProxyInput
- data ApiGatewayProxySummary = ApiGatewayProxySummary' (Maybe Text) (Maybe ApiGatewayEndpointType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newApiGatewayProxySummary :: ApiGatewayProxySummary
- data ApplicationSummary = ApplicationSummary' (Maybe ApiGatewayProxySummary) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text)
- newApplicationSummary :: ApplicationSummary
- data DefaultRouteInput = DefaultRouteInput' (Maybe RouteActivationState)
- newDefaultRouteInput :: DefaultRouteInput
- data EnvironmentSummary = EnvironmentSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text)
- newEnvironmentSummary :: EnvironmentSummary
- data EnvironmentVpc = EnvironmentVpc' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newEnvironmentVpc :: EnvironmentVpc
- data ErrorResponse = ErrorResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ErrorCode) (Maybe Text) (Maybe Text) (Maybe ErrorResourceType)
- newErrorResponse :: ErrorResponse
- data LambdaEndpointConfig = LambdaEndpointConfig' (Maybe Text)
- newLambdaEndpointConfig :: LambdaEndpointConfig
- data LambdaEndpointInput = LambdaEndpointInput' Text
- newLambdaEndpointInput :: Text -> LambdaEndpointInput
- data LambdaEndpointSummary = LambdaEndpointSummary' (Maybe Text)
- newLambdaEndpointSummary :: LambdaEndpointSummary
- data RouteSummary = RouteSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe Bool) (Maybe POSIX) (Maybe [HttpMethod]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text)))
- newRouteSummary :: RouteSummary
- data ServiceSummary = ServiceSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe ErrorResponse) (Maybe LambdaEndpointSummary) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointSummary) (Maybe Text)
- newServiceSummary :: ServiceSummary
- data UriPathRouteInput = UriPathRouteInput' (Maybe Bool) (Maybe [HttpMethod]) RouteActivationState Text
- newUriPathRouteInput :: RouteActivationState -> Text -> UriPathRouteInput
- data UrlEndpointConfig = UrlEndpointConfig' (Maybe Text) (Maybe Text)
- newUrlEndpointConfig :: UrlEndpointConfig
- data UrlEndpointInput = UrlEndpointInput' (Maybe Text) Text
- newUrlEndpointInput :: Text -> UrlEndpointInput
- data UrlEndpointSummary = UrlEndpointSummary' (Maybe Text) (Maybe Text)
- newUrlEndpointSummary :: UrlEndpointSummary
Service Configuration
defaultService :: Service Source #
API version 2021-10-26
of the Amazon Migration Hub Refactor Spaces SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MigrationHubReFactorSpaces
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
The user does not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Updating or deleting a resource can cause an inconsistent state.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
An unexpected error occurred while processing the request.
InvalidResourcePolicyException
_InvalidResourcePolicyException :: AsError a => Fold a ServiceError Source #
The resource policy is not valid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource that does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Request was denied because the request was throttled.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input does not satisfy the constraints specified by an Amazon Web Service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateApplication
data CreateApplication Source #
See: newCreateApplication
smart constructor.
CreateApplication' (Maybe ApiGatewayProxyInput) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Text Text ProxyType Text |
Instances
:: Text | |
-> Text | |
-> ProxyType | |
-> Text | |
-> CreateApplication |
Create a value of CreateApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApplication
, createApplication_apiGatewayProxy
- A wrapper object holding the API Gateway endpoint type and stage name
for the proxy.
$sel:clientToken:CreateApplication'
, createApplication_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateApplication
, createApplication_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.
$sel:environmentIdentifier:CreateApplication'
, createApplication_environmentIdentifier
- The unique identifier of the environment.
CreateApplication
, createApplication_name
- The name to use for the application.
CreateApplication
, createApplication_proxyType
- The proxy type of the proxy created within the application.
CreateApplication
, createApplication_vpcId
- The ID of the virtual private cloud (VPC).
data CreateApplicationResponse Source #
See: newCreateApplicationResponse
smart constructor.
CreateApplicationResponse' (Maybe ApiGatewayProxyInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int |
Instances
newCreateApplicationResponse Source #
Create a value of CreateApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApplication
, createApplicationResponse_apiGatewayProxy
- A wrapper object holding the API Gateway endpoint type and stage name
for the proxy.
CreateApplicationResponse
, createApplicationResponse_applicationId
- The unique identifier of the application.
CreateApplicationResponse
, 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.
CreateApplicationResponse
, createApplicationResponse_createdByAccountId
- The Amazon Web Services account ID of application creator.
CreateApplicationResponse
, createApplicationResponse_createdTime
- A timestamp that indicates when the application is created.
CreateApplicationResponse
, createApplicationResponse_environmentId
- The ID of the environment in which the application is created.
CreateApplicationResponse
, createApplicationResponse_lastUpdatedTime
- A timestamp that indicates when the application was last updated.
CreateApplication
, createApplicationResponse_name
- The name of the application.
CreateApplicationResponse
, createApplicationResponse_ownerAccountId
- The Amazon Web Services account ID of the application owner (which is
always the same as the environment owner account ID).
CreateApplication
, createApplicationResponse_proxyType
- The proxy type of the proxy created within the application.
CreateApplicationResponse
, createApplicationResponse_state
- The current state of the application.
CreateApplication
, 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.
CreateApplication
, createApplicationResponse_vpcId
- The ID of the Amazon VPC.
$sel:httpStatus:CreateApplicationResponse'
, createApplicationResponse_httpStatus
- The response's http status code.
CreateEnvironment
data CreateEnvironment Source #
See: newCreateEnvironment
smart constructor.
CreateEnvironment' (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Text NetworkFabricType |
Instances
Create a value of CreateEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateEnvironment'
, createEnvironment_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateEnvironment
, createEnvironment_description
- The description of the environment.
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_name
- The name of the environment.
CreateEnvironment
, createEnvironment_networkFabricType
- The network fabric type of the environment.
data CreateEnvironmentResponse Source #
See: newCreateEnvironmentResponse
smart constructor.
CreateEnvironmentResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) Int |
Instances
newCreateEnvironmentResponse Source #
Create a value of CreateEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEnvironmentResponse
, createEnvironmentResponse_arn
- The Amazon Resource Name (ARN) of the environment.
CreateEnvironmentResponse
, createEnvironmentResponse_createdTime
- A timestamp that indicates when the environment is created.
CreateEnvironment
, createEnvironmentResponse_description
- A description of the environment.
CreateEnvironmentResponse
, createEnvironmentResponse_environmentId
- The unique identifier of the environment.
CreateEnvironmentResponse
, createEnvironmentResponse_lastUpdatedTime
- A timestamp that indicates when the environment was last updated.
CreateEnvironment
, createEnvironmentResponse_name
- The name of the environment.
CreateEnvironment
, createEnvironmentResponse_networkFabricType
- The network fabric type of the environment.
CreateEnvironmentResponse
, createEnvironmentResponse_ownerAccountId
- The Amazon Web Services account ID of environment owner.
CreateEnvironmentResponse
, createEnvironmentResponse_state
- The current state of the environment.
CreateEnvironment
, 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..
$sel:httpStatus:CreateEnvironmentResponse'
, createEnvironmentResponse_httpStatus
- The response's http status code.
CreateRoute
data CreateRoute Source #
See: newCreateRoute
smart constructor.
CreateRoute' (Maybe Text) (Maybe DefaultRouteInput) (Maybe (Sensitive (HashMap Text Text))) (Maybe UriPathRouteInput) Text Text RouteType Text |
Instances
:: Text | |
-> Text | |
-> RouteType | |
-> Text | |
-> CreateRoute |
Create a value of CreateRoute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateRoute'
, createRoute_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:defaultRoute:CreateRoute'
, createRoute_defaultRoute
- Configuration for the default route type.
CreateRoute
, createRoute_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..
CreateRoute
, createRoute_uriPathRoute
- The configuration for the URI path route type.
$sel:applicationIdentifier:CreateRoute'
, createRoute_applicationIdentifier
- The ID of the application within which the route is being created.
$sel:environmentIdentifier:CreateRoute'
, createRoute_environmentIdentifier
- The ID of the environment in which the route is created.
CreateRoute
, createRoute_routeType
- 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.
$sel:serviceIdentifier:CreateRoute'
, createRoute_serviceIdentifier
- The ID of the service in which the route is created. Traffic that
matches this route is forwarded to this service.
data CreateRouteResponse Source #
See: newCreateRouteResponse
smart constructor.
CreateRouteResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UriPathRouteInput) Int |
Instances
newCreateRouteResponse Source #
Create a value of CreateRouteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRouteResponse
, createRouteResponse_applicationId
- The ID of the application in which the route is created.
CreateRouteResponse
, 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.
CreateRouteResponse
, createRouteResponse_createdByAccountId
- The Amazon Web Services account ID of the route creator.
CreateRouteResponse
, createRouteResponse_createdTime
- A timestamp that indicates when the route is created.
CreateRouteResponse
, createRouteResponse_lastUpdatedTime
- A timestamp that indicates when the route was last updated.
CreateRouteResponse
, createRouteResponse_ownerAccountId
- The Amazon Web Services account ID of the route owner.
CreateRouteResponse
, createRouteResponse_routeId
- The unique identifier of the route.
CreateRoute
, createRouteResponse_routeType
- The route type of the route.
CreateRouteResponse
, createRouteResponse_serviceId
- The ID of service in which the route is created. Traffic that matches
this route is forwarded to this service.
CreateRouteResponse
, createRouteResponse_state
- 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.
CreateRoute
, 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.
CreateRoute
, createRouteResponse_uriPathRoute
- Configuration for the URI path route type.
$sel:httpStatus:CreateRouteResponse'
, createRouteResponse_httpStatus
- The response's http status code.
CreateService
data CreateService Source #
See: newCreateService
smart constructor.
CreateService' (Maybe Text) (Maybe Text) (Maybe LambdaEndpointInput) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointInput) (Maybe Text) Text ServiceEndpointType Text Text |
Instances
:: Text | |
-> ServiceEndpointType | |
-> Text | |
-> Text | |
-> CreateService |
Create a value of CreateService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateService'
, createService_clientToken
- A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
CreateService
, createService_description
- The description of the service.
CreateService
, createService_lambdaEndpoint
- The configuration for the Lambda endpoint type.
CreateService
, createService_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..
CreateService
, createService_urlEndpoint
- 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
, createService_vpcId
- The ID of the VPC.
$sel:applicationIdentifier:CreateService'
, createService_applicationIdentifier
- The ID of the application which the service is created.
CreateService
, createService_endpointType
- The type of endpoint to use for the service. The type can be a URL in a
VPC or an Lambda function.
$sel:environmentIdentifier:CreateService'
, createService_environmentIdentifier
- The ID of the environment in which the service is created.
CreateService
, createService_name
- The name of the service.
data CreateServiceResponse Source #
See: newCreateServiceResponse
smart constructor.
CreateServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe LambdaEndpointInput) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointInput) (Maybe Text) Int |
Instances
newCreateServiceResponse Source #
Create a value of CreateServiceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateServiceResponse
, createServiceResponse_applicationId
- The ID of the application that the created service belongs to.
CreateServiceResponse
, createServiceResponse_arn
- The Amazon Resource Name (ARN) of the service.
CreateServiceResponse
, createServiceResponse_createdByAccountId
- The Amazon Web Services account ID of the service creator.
CreateServiceResponse
, createServiceResponse_createdTime
- A timestamp that indicates when the service is created.
CreateService
, createServiceResponse_description
- The description of the created service.
CreateService
, createServiceResponse_endpointType
- The endpoint type of the service.
CreateServiceResponse
, createServiceResponse_environmentId
- The unique identifier of the environment.
CreateService
, createServiceResponse_lambdaEndpoint
- The configuration for the Lambda endpoint type.
CreateServiceResponse
, createServiceResponse_lastUpdatedTime
- A timestamp that indicates when the service was last updated.
CreateService
, createServiceResponse_name
- The name of the service.
CreateServiceResponse
, createServiceResponse_ownerAccountId
- The Amazon Web Services account ID of the service owner.
CreateServiceResponse
, createServiceResponse_serviceId
- The unique identifier of the service.
CreateServiceResponse
, createServiceResponse_state
- The current state of the service.
CreateService
, 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..
CreateService
, createServiceResponse_urlEndpoint
- The configuration for the URL endpoint type.
CreateService
, createServiceResponse_vpcId
- The ID of the VPC.
$sel:httpStatus:CreateServiceResponse'
, createServiceResponse_httpStatus
- The response's http status code.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication
smart constructor.
Instances
:: Text | |
-> Text | |
-> DeleteApplication |
Create a value of DeleteApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:DeleteApplication'
, deleteApplication_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:DeleteApplication'
, deleteApplication_environmentIdentifier
- The ID of the environment.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse
smart constructor.
DeleteApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ApplicationState) Int |
Instances
newDeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApplicationResponse
, deleteApplicationResponse_applicationId
- The ID of the application.
DeleteApplicationResponse
, deleteApplicationResponse_arn
- The Amazon Resource Name (ARN) of the application.
DeleteApplicationResponse
, deleteApplicationResponse_environmentId
- The unique identifier of the application’s environment.
DeleteApplicationResponse
, deleteApplicationResponse_lastUpdatedTime
- A timestamp that indicates when the environment was last updated.
DeleteApplicationResponse
, deleteApplicationResponse_name
- The name of the application.
DeleteApplicationResponse
, deleteApplicationResponse_state
- The current state of the application.
$sel:httpStatus:DeleteApplicationResponse'
, deleteApplicationResponse_httpStatus
- The response's http status code.
DeleteEnvironment
data DeleteEnvironment Source #
See: newDeleteEnvironment
smart constructor.
Instances
Create a value of DeleteEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentIdentifier:DeleteEnvironment'
, deleteEnvironment_environmentIdentifier
- The ID of the environment.
data DeleteEnvironmentResponse Source #
See: newDeleteEnvironmentResponse
smart constructor.
DeleteEnvironmentResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe EnvironmentState) Int |
Instances
newDeleteEnvironmentResponse Source #
Create a value of DeleteEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEnvironmentResponse
, deleteEnvironmentResponse_arn
- The Amazon Resource Name (ARN) of the environment.
DeleteEnvironmentResponse
, deleteEnvironmentResponse_environmentId
- The unique identifier of the environment.
DeleteEnvironmentResponse
, deleteEnvironmentResponse_lastUpdatedTime
- A timestamp that indicates when the environment was last updated.
DeleteEnvironmentResponse
, deleteEnvironmentResponse_name
- The name of the environment.
DeleteEnvironmentResponse
, deleteEnvironmentResponse_state
- The current state of the environment.
$sel:httpStatus:DeleteEnvironmentResponse'
, deleteEnvironmentResponse_httpStatus
- The response's http status code.
DeleteResourcePolicy
data DeleteResourcePolicy Source #
See: newDeleteResourcePolicy
smart constructor.
Instances
newDeleteResourcePolicy Source #
Create a value of DeleteResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identifier:DeleteResourcePolicy'
, deleteResourcePolicy_identifier
- Amazon Resource Name (ARN) of the resource associated with the policy.
data DeleteResourcePolicyResponse Source #
See: newDeleteResourcePolicyResponse
smart constructor.
Instances
Generic DeleteResourcePolicyResponse Source # | |
Read DeleteResourcePolicyResponse Source # | |
Show DeleteResourcePolicyResponse Source # | |
NFData DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.MigrationHubReFactorSpaces.DeleteResourcePolicy rnf :: DeleteResourcePolicyResponse -> () # | |
Eq DeleteResourcePolicyResponse Source # | |
type Rep DeleteResourcePolicyResponse Source # | |
Defined in Amazonka.MigrationHubReFactorSpaces.DeleteResourcePolicy type Rep DeleteResourcePolicyResponse = D1 ('MetaData "DeleteResourcePolicyResponse" "Amazonka.MigrationHubReFactorSpaces.DeleteResourcePolicy" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "DeleteResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteResourcePolicyResponse Source #
Create a value of DeleteResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteResourcePolicyResponse'
, deleteResourcePolicyResponse_httpStatus
- The response's http status code.
DeleteRoute
data DeleteRoute Source #
See: newDeleteRoute
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteRoute |
Create a value of DeleteRoute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:DeleteRoute'
, deleteRoute_applicationIdentifier
- The ID of the application to delete the route from.
$sel:environmentIdentifier:DeleteRoute'
, deleteRoute_environmentIdentifier
- The ID of the environment to delete the route from.
$sel:routeIdentifier:DeleteRoute'
, deleteRoute_routeIdentifier
- The ID of the route to delete.
data DeleteRouteResponse Source #
See: newDeleteRouteResponse
smart constructor.
DeleteRouteResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteState) Int |
Instances
newDeleteRouteResponse Source #
Create a value of DeleteRouteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteRouteResponse
, deleteRouteResponse_applicationId
- The ID of the application that the route belongs to.
DeleteRouteResponse
, deleteRouteResponse_arn
- The Amazon Resource Name (ARN) of the route.
DeleteRouteResponse
, deleteRouteResponse_lastUpdatedTime
- A timestamp that indicates when the route was last updated.
DeleteRouteResponse
, deleteRouteResponse_routeId
- The ID of the route to delete.
DeleteRouteResponse
, deleteRouteResponse_serviceId
- The ID of the service that the route belongs to.
DeleteRouteResponse
, deleteRouteResponse_state
- The current state of the route.
$sel:httpStatus:DeleteRouteResponse'
, deleteRouteResponse_httpStatus
- The response's http status code.
DeleteService
data DeleteService Source #
See: newDeleteService
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> DeleteService |
Create a value of DeleteService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:DeleteService'
, deleteService_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.
$sel:environmentIdentifier:DeleteService'
, deleteService_environmentIdentifier
- The ID of the environment that the service is in.
$sel:serviceIdentifier:DeleteService'
, deleteService_serviceIdentifier
- The ID of the service to delete.
data DeleteServiceResponse Source #
See: newDeleteServiceResponse
smart constructor.
DeleteServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ServiceState) Int |
Instances
newDeleteServiceResponse Source #
Create a value of DeleteServiceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteServiceResponse
, deleteServiceResponse_applicationId
- The ID of the application that the service is in.
DeleteServiceResponse
, deleteServiceResponse_arn
- The Amazon Resource Name (ARN) of the service.
DeleteServiceResponse
, deleteServiceResponse_environmentId
- The unique identifier of the environment.
DeleteServiceResponse
, deleteServiceResponse_lastUpdatedTime
- A timestamp that indicates when the service was last updated.
DeleteServiceResponse
, deleteServiceResponse_name
- The name of the service.
DeleteServiceResponse
, deleteServiceResponse_serviceId
- The unique identifier of the service.
DeleteServiceResponse
, deleteServiceResponse_state
- The current state of the service.
$sel:httpStatus:DeleteServiceResponse'
, deleteServiceResponse_httpStatus
- The response's http status code.
GetApplication
data GetApplication Source #
See: newGetApplication
smart constructor.
Instances
:: Text | |
-> Text | |
-> GetApplication |
Create a value of GetApplication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:GetApplication'
, getApplication_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:GetApplication'
, getApplication_environmentIdentifier
- The ID of the environment.
data GetApplicationResponse Source #
See: newGetApplicationResponse
smart constructor.
GetApplicationResponse' (Maybe ApiGatewayProxyConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int |
Instances
newGetApplicationResponse Source #
Create a value of GetApplicationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetApplicationResponse
, getApplicationResponse_apiGatewayProxy
- The endpoint URL of the API Gateway proxy.
GetApplicationResponse
, getApplicationResponse_applicationId
- The unique identifier of the application.
GetApplicationResponse
, getApplicationResponse_arn
- The Amazon Resource Name (ARN) of the application.
GetApplicationResponse
, getApplicationResponse_createdByAccountId
- The Amazon Web Services account ID of the application creator.
GetApplicationResponse
, getApplicationResponse_createdTime
- A timestamp that indicates when the application is created.
GetApplicationResponse
, getApplicationResponse_environmentId
- The unique identifier of the environment.
GetApplicationResponse
, getApplicationResponse_error
- Any error associated with the application resource.
GetApplicationResponse
, getApplicationResponse_lastUpdatedTime
- A timestamp that indicates when the application was last updated.
GetApplicationResponse
, getApplicationResponse_name
- The name of the application.
GetApplicationResponse
, getApplicationResponse_ownerAccountId
- The Amazon Web Services account ID of the application owner (which is
always the same as the environment owner account ID).
GetApplicationResponse
, getApplicationResponse_proxyType
- The proxy type of the proxy created within the application.
GetApplicationResponse
, getApplicationResponse_state
- The current state of the application.
GetApplicationResponse
, 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.
GetApplicationResponse
, getApplicationResponse_vpcId
- The ID of the virtual private cloud (VPC).
$sel:httpStatus:GetApplicationResponse'
, getApplicationResponse_httpStatus
- The response's http status code.
GetEnvironment
data GetEnvironment Source #
See: newGetEnvironment
smart constructor.
Instances
Create a value of GetEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentIdentifier:GetEnvironment'
, getEnvironment_environmentIdentifier
- The ID of the environment.
data GetEnvironmentResponse Source #
See: newGetEnvironmentResponse
smart constructor.
GetEnvironmentResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) Int |
Instances
newGetEnvironmentResponse Source #
Create a value of GetEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEnvironmentResponse
, getEnvironmentResponse_arn
- The Amazon Resource Name (ARN) of the environment.
GetEnvironmentResponse
, getEnvironmentResponse_createdTime
- A timestamp that indicates when the environment is created.
GetEnvironmentResponse
, getEnvironmentResponse_description
- The description of the environment.
GetEnvironmentResponse
, getEnvironmentResponse_environmentId
- The unique identifier of the environment.
GetEnvironmentResponse
, getEnvironmentResponse_error
- Any error associated with the environment resource.
GetEnvironmentResponse
, getEnvironmentResponse_lastUpdatedTime
- A timestamp that indicates when the environment was last updated.
GetEnvironmentResponse
, getEnvironmentResponse_name
- The name of the environment.
GetEnvironmentResponse
, getEnvironmentResponse_networkFabricType
- The network fabric type of the environment.
GetEnvironmentResponse
, getEnvironmentResponse_ownerAccountId
- The Amazon Web Services account ID of the environment owner.
GetEnvironmentResponse
, getEnvironmentResponse_state
- The current state of the environment.
GetEnvironmentResponse
, 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.
GetEnvironmentResponse
, getEnvironmentResponse_transitGatewayId
- The ID of the transit gateway set up by the environment.
$sel:httpStatus:GetEnvironmentResponse'
, getEnvironmentResponse_httpStatus
- The response's http status code.
GetResourcePolicy
data GetResourcePolicy Source #
See: newGetResourcePolicy
smart constructor.
Instances
Create a value of GetResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identifier:GetResourcePolicy'
, getResourcePolicy_identifier
- The Amazon Resource Name (ARN) of the resource associated with the
policy.
data GetResourcePolicyResponse Source #
See: newGetResourcePolicyResponse
smart constructor.
Instances
newGetResourcePolicyResponse Source #
Create a value of GetResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:GetResourcePolicyResponse'
, getResourcePolicyResponse_policy
- A JSON-formatted string for an Amazon Web Services resource-based
policy.
$sel:httpStatus:GetResourcePolicyResponse'
, getResourcePolicyResponse_httpStatus
- The response's http status code.
GetRoute
See: newGetRoute
smart constructor.
Instances
Create a value of GetRoute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:GetRoute'
, getRoute_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:GetRoute'
, getRoute_environmentIdentifier
- The ID of the environment.
$sel:routeIdentifier:GetRoute'
, getRoute_routeIdentifier
- The ID of the route.
data GetRouteResponse Source #
See: newGetRouteResponse
smart constructor.
GetRouteResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe Bool) (Maybe POSIX) (Maybe [HttpMethod]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text))) Int |
Instances
Create a value of GetRouteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRouteResponse
, getRouteResponse_applicationId
- The ID of the application that the route belongs to.
GetRouteResponse
, getRouteResponse_arn
- The Amazon Resource Name (ARN) of the route.
GetRouteResponse
, getRouteResponse_createdByAccountId
- The Amazon Web Services account ID of the route creator.
GetRouteResponse
, getRouteResponse_createdTime
- The timestamp of when the route is created.
GetRouteResponse
, getRouteResponse_environmentId
- Unique identifier of the environment.
GetRouteResponse
, getRouteResponse_error
- Any error associated with the route resource.
GetRouteResponse
, getRouteResponse_includeChildPaths
- 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
, getRouteResponse_lastUpdatedTime
- A timestamp that indicates when the route was last updated.
GetRouteResponse
, 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.
GetRouteResponse
, getRouteResponse_ownerAccountId
- The Amazon Web Services account ID of the route owner.
GetRouteResponse
, getRouteResponse_pathResourceToId
- A mapping of Amazon API Gateway path resources to resource IDs.
GetRouteResponse
, 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.
GetRouteResponse
, getRouteResponse_routeType
- The type of route.
GetRouteResponse
, getRouteResponse_serviceId
- The unique identifier of the service.
GetRouteResponse
, getRouteResponse_sourcePath
- The path to use to match traffic. Paths must start with /
and are
relative to the base of the application.
GetRouteResponse
, getRouteResponse_state
- The current state of the route.
GetRouteResponse
, 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.
$sel:httpStatus:GetRouteResponse'
, getRouteResponse_httpStatus
- The response's http status code.
GetService
data GetService Source #
See: newGetService
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> GetService |
Create a value of GetService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIdentifier:GetService'
, getService_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:GetService'
, getService_environmentIdentifier
- The ID of the environment.
$sel:serviceIdentifier:GetService'
, getService_serviceIdentifier
- The ID of the service.
data GetServiceResponse Source #
See: newGetServiceResponse
smart constructor.
GetServiceResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe ErrorResponse) (Maybe LambdaEndpointConfig) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointConfig) (Maybe Text) Int |
Instances
newGetServiceResponse Source #
Create a value of GetServiceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetServiceResponse
, getServiceResponse_applicationId
- The ID of the application.
GetServiceResponse
, getServiceResponse_arn
- The Amazon Resource Name (ARN) of the service.
GetServiceResponse
, getServiceResponse_createdByAccountId
- The Amazon Web Services account ID of the service creator.
GetServiceResponse
, getServiceResponse_createdTime
- The timestamp of when the service is created.
GetServiceResponse
, getServiceResponse_description
- The description of the service.
GetServiceResponse
, getServiceResponse_endpointType
- The endpoint type of the service.
GetServiceResponse
, getServiceResponse_environmentId
- The unique identifier of the environment.
GetServiceResponse
, getServiceResponse_error
- Any error associated with the service resource.
GetServiceResponse
, 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.
GetServiceResponse
, getServiceResponse_lastUpdatedTime
- A timestamp that indicates when the service was last updated.
GetServiceResponse
, getServiceResponse_name
- The name of the service.
GetServiceResponse
, getServiceResponse_ownerAccountId
- The Amazon Web Services account ID of the service owner.
GetServiceResponse
, getServiceResponse_serviceId
- The unique identifier of the service.
GetServiceResponse
, getServiceResponse_state
- The current state of the service.
GetServiceResponse
, 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.
GetServiceResponse
, 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.
GetServiceResponse
, getServiceResponse_vpcId
- The ID of the virtual private cloud (VPC).
$sel:httpStatus:GetServiceResponse'
, getServiceResponse_httpStatus
- The response's http status code.
ListApplications (Paginated)
data ListApplications Source #
See: newListApplications
smart constructor.
Instances
Create a value of ListApplications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListApplications'
, listApplications_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.
ListApplications
, listApplications_nextToken
- The token for the next page of results.
$sel:environmentIdentifier:ListApplications'
, listApplications_environmentIdentifier
- The ID of the environment.
data ListApplicationsResponse Source #
See: newListApplicationsResponse
smart constructor.
Instances
newListApplicationsResponse Source #
Create a value of ListApplicationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationSummaryList:ListApplicationsResponse'
, listApplicationsResponse_applicationSummaryList
- The list of ApplicationSummary
objects.
ListApplications
, listApplicationsResponse_nextToken
- The token for the next page of results.
$sel:httpStatus:ListApplicationsResponse'
, listApplicationsResponse_httpStatus
- The response's http status code.
ListEnvironmentVpcs (Paginated)
data ListEnvironmentVpcs Source #
See: newListEnvironmentVpcs
smart constructor.
Instances
newListEnvironmentVpcs Source #
Create a value of ListEnvironmentVpcs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEnvironmentVpcs'
, listEnvironmentVpcs_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.
ListEnvironmentVpcs
, listEnvironmentVpcs_nextToken
- The token for the next page of results.
$sel:environmentIdentifier:ListEnvironmentVpcs'
, listEnvironmentVpcs_environmentIdentifier
- The ID of the environment.
data ListEnvironmentVpcsResponse Source #
See: newListEnvironmentVpcsResponse
smart constructor.
Instances
newListEnvironmentVpcsResponse Source #
Create a value of ListEnvironmentVpcsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentVpcList:ListEnvironmentVpcsResponse'
, listEnvironmentVpcsResponse_environmentVpcList
- The list of EnvironmentVpc
objects.
ListEnvironmentVpcs
, listEnvironmentVpcsResponse_nextToken
- The token for the next page of results.
$sel:httpStatus:ListEnvironmentVpcsResponse'
, listEnvironmentVpcsResponse_httpStatus
- The response's http status code.
ListEnvironments (Paginated)
data ListEnvironments Source #
See: newListEnvironments
smart constructor.
Instances
newListEnvironments :: ListEnvironments Source #
Create a value of ListEnvironments
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEnvironments'
, listEnvironments_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.
ListEnvironments
, listEnvironments_nextToken
- The token for the next page of results.
data ListEnvironmentsResponse Source #
See: newListEnvironmentsResponse
smart constructor.
Instances
newListEnvironmentsResponse Source #
Create a value of ListEnvironmentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentSummaryList:ListEnvironmentsResponse'
, listEnvironmentsResponse_environmentSummaryList
- The list of EnvironmentSummary
objects.
ListEnvironments
, listEnvironmentsResponse_nextToken
- The token for the next page of results.
$sel:httpStatus:ListEnvironmentsResponse'
, listEnvironmentsResponse_httpStatus
- The response's http status code.
ListRoutes (Paginated)
data ListRoutes Source #
See: newListRoutes
smart constructor.
Instances
:: Text | |
-> Text | |
-> ListRoutes |
Create a value of ListRoutes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRoutes'
, listRoutes_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.
ListRoutes
, listRoutes_nextToken
- The token for the next page of results.
$sel:applicationIdentifier:ListRoutes'
, listRoutes_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:ListRoutes'
, listRoutes_environmentIdentifier
- The ID of the environment.
data ListRoutesResponse Source #
See: newListRoutesResponse
smart constructor.
Instances
newListRoutesResponse Source #
Create a value of ListRoutesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRoutes
, listRoutesResponse_nextToken
- The token for the next page of results.
$sel:routeSummaryList:ListRoutesResponse'
, listRoutesResponse_routeSummaryList
- The list of RouteSummary
objects.
$sel:httpStatus:ListRoutesResponse'
, listRoutesResponse_httpStatus
- The response's http status code.
ListServices (Paginated)
data ListServices Source #
See: newListServices
smart constructor.
Instances
:: Text | |
-> Text | |
-> ListServices |
Create a value of ListServices
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListServices'
, listServices_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.
ListServices
, listServices_nextToken
- The token for the next page of results.
$sel:applicationIdentifier:ListServices'
, listServices_applicationIdentifier
- The ID of the application.
$sel:environmentIdentifier:ListServices'
, listServices_environmentIdentifier
- The ID of the environment.
data ListServicesResponse Source #
See: newListServicesResponse
smart constructor.
Instances
newListServicesResponse Source #
Create a value of ListServicesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListServices
, listServicesResponse_nextToken
- The token for the next page of results.
$sel:serviceSummaryList:ListServicesResponse'
, listServicesResponse_serviceSummaryList
- The list of ServiceSummary
objects.
$sel:httpStatus:ListServicesResponse'
, listServicesResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The list of tags assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
PutResourcePolicy
data PutResourcePolicy Source #
See: newPutResourcePolicy
smart constructor.
Instances
Create a value of PutResourcePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:PutResourcePolicy'
, putResourcePolicy_policy
- A JSON-formatted string for an Amazon Web Services resource-based
policy.
$sel:resourceArn:PutResourcePolicy'
, putResourcePolicy_resourceArn
- The Amazon Resource Name (ARN) of the resource to which the policy is
being attached.
data PutResourcePolicyResponse Source #
See: newPutResourcePolicyResponse
smart constructor.
Instances
newPutResourcePolicyResponse Source #
Create a value of PutResourcePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutResourcePolicyResponse'
, putResourcePolicyResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
TagResource
, tagResource_tags
- The new or modified tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of keys of the tags to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateRoute
data UpdateRoute Source #
See: newUpdateRoute
smart constructor.
Instances
:: RouteActivationState | |
-> Text | |
-> Text | |
-> Text | |
-> UpdateRoute |
Create a value of UpdateRoute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRoute
, updateRoute_activationState
- If set to ACTIVE
, traffic is forwarded to this route’s service after
the route is updated.
$sel:applicationIdentifier:UpdateRoute'
, updateRoute_applicationIdentifier
- The ID of the application within which the route is being updated.
$sel:environmentIdentifier:UpdateRoute'
, updateRoute_environmentIdentifier
- The ID of the environment in which the route is being updated.
$sel:routeIdentifier:UpdateRoute'
, updateRoute_routeIdentifier
- The unique identifier of the route to update.
data UpdateRouteResponse Source #
See: newUpdateRouteResponse
smart constructor.
UpdateRouteResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RouteState) Int |
Instances
newUpdateRouteResponse Source #
Create a value of UpdateRouteResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRouteResponse
, updateRouteResponse_applicationId
- The ID of the application in which the route is being updated.
UpdateRouteResponse
, updateRouteResponse_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.
UpdateRouteResponse
, updateRouteResponse_lastUpdatedTime
- A timestamp that indicates when the route was last updated.
UpdateRouteResponse
, updateRouteResponse_routeId
- The unique identifier of the route.
UpdateRouteResponse
, updateRouteResponse_serviceId
- The ID of service in which the route was created. Traffic that matches
this route is forwarded to this service.
UpdateRouteResponse
, updateRouteResponse_state
- The current state of the route.
$sel:httpStatus:UpdateRouteResponse'
, updateRouteResponse_httpStatus
- The response's http status code.
Types
ApiGatewayEndpointType
newtype ApiGatewayEndpointType Source #
pattern ApiGatewayEndpointType_PRIVATE :: ApiGatewayEndpointType | |
pattern ApiGatewayEndpointType_REGIONAL :: ApiGatewayEndpointType |
Instances
ApplicationState
newtype ApplicationState Source #
pattern ApplicationState_ACTIVE :: ApplicationState | |
pattern ApplicationState_CREATING :: ApplicationState | |
pattern ApplicationState_DELETING :: ApplicationState | |
pattern ApplicationState_FAILED :: ApplicationState | |
pattern ApplicationState_UPDATING :: ApplicationState |
Instances
EnvironmentState
newtype EnvironmentState Source #
pattern EnvironmentState_ACTIVE :: EnvironmentState | |
pattern EnvironmentState_CREATING :: EnvironmentState | |
pattern EnvironmentState_DELETING :: EnvironmentState | |
pattern EnvironmentState_FAILED :: EnvironmentState |
Instances
ErrorCode
pattern ErrorCode_INVALID_RESOURCE_STATE :: ErrorCode | |
pattern ErrorCode_NOT_AUTHORIZED :: ErrorCode | |
pattern ErrorCode_REQUEST_LIMIT_EXCEEDED :: ErrorCode | |
pattern ErrorCode_RESOURCE_CREATION_FAILURE :: ErrorCode | |
pattern ErrorCode_RESOURCE_DELETION_FAILURE :: ErrorCode | |
pattern ErrorCode_RESOURCE_IN_USE :: ErrorCode | |
pattern ErrorCode_RESOURCE_LIMIT_EXCEEDED :: ErrorCode | |
pattern ErrorCode_RESOURCE_NOT_FOUND :: ErrorCode | |
pattern ErrorCode_RESOURCE_RETRIEVAL_FAILURE :: ErrorCode | |
pattern ErrorCode_RESOURCE_UPDATE_FAILURE :: ErrorCode | |
pattern ErrorCode_SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE :: ErrorCode | |
pattern ErrorCode_STATE_TRANSITION_FAILURE :: ErrorCode |
Instances
ErrorResourceType
newtype ErrorResourceType Source #
Instances
HttpMethod
newtype HttpMethod Source #
pattern HttpMethod_DELETE :: HttpMethod | |
pattern HttpMethod_GET :: HttpMethod | |
pattern HttpMethod_HEAD :: HttpMethod | |
pattern HttpMethod_OPTIONS :: HttpMethod | |
pattern HttpMethod_PATCH :: HttpMethod | |
pattern HttpMethod_POST :: HttpMethod | |
pattern HttpMethod_PUT :: HttpMethod |
Instances
NetworkFabricType
newtype NetworkFabricType Source #
Instances
ProxyType
pattern ProxyType_API_GATEWAY :: ProxyType |
Instances
RouteActivationState
newtype RouteActivationState Source #
pattern RouteActivationState_ACTIVE :: RouteActivationState | |
pattern RouteActivationState_INACTIVE :: RouteActivationState |
Instances
RouteState
newtype RouteState Source #
pattern RouteState_ACTIVE :: RouteState | |
pattern RouteState_CREATING :: RouteState | |
pattern RouteState_DELETING :: RouteState | |
pattern RouteState_FAILED :: RouteState | |
pattern RouteState_INACTIVE :: RouteState | |
pattern RouteState_UPDATING :: RouteState |
Instances
RouteType
pattern RouteType_DEFAULT :: RouteType | |
pattern RouteType_URI_PATH :: RouteType |
Instances
ServiceEndpointType
newtype ServiceEndpointType Source #
pattern ServiceEndpointType_LAMBDA :: ServiceEndpointType | |
pattern ServiceEndpointType_URL :: ServiceEndpointType |
Instances
ServiceState
newtype ServiceState Source #
pattern ServiceState_ACTIVE :: ServiceState | |
pattern ServiceState_CREATING :: ServiceState | |
pattern ServiceState_DELETING :: ServiceState | |
pattern ServiceState_FAILED :: ServiceState |
Instances
ApiGatewayProxyConfig
data ApiGatewayProxyConfig Source #
A wrapper object holding the Amazon API Gateway proxy configuration.
See: newApiGatewayProxyConfig
smart constructor.
ApiGatewayProxyConfig' (Maybe Text) (Maybe ApiGatewayEndpointType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newApiGatewayProxyConfig :: ApiGatewayProxyConfig Source #
Create a value of ApiGatewayProxyConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiGatewayId:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_apiGatewayId
- The resource ID of the API Gateway for the proxy.
$sel:endpointType:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_endpointType
- The type of API Gateway endpoint created.
$sel:nlbArn:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_nlbArn
- The Amazon Resource Name (ARN) of the Network Load Balancer configured
by the API Gateway proxy.
$sel:nlbName:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_nlbName
- The name of the Network Load Balancer that is configured by the API
Gateway proxy.
$sel:proxyUrl:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_proxyUrl
- The endpoint URL of the API Gateway proxy.
$sel:stageName:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_stageName
- The name of the API Gateway stage. The name defaults to prod
.
$sel:vpcLinkId:ApiGatewayProxyConfig'
, apiGatewayProxyConfig_vpcLinkId
- The VpcLink
ID of the API Gateway proxy.
ApiGatewayProxyInput
data ApiGatewayProxyInput Source #
A wrapper object holding the Amazon API Gateway endpoint input.
See: newApiGatewayProxyInput
smart constructor.
Instances
newApiGatewayProxyInput :: ApiGatewayProxyInput Source #
Create a value of ApiGatewayProxyInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endpointType:ApiGatewayProxyInput'
, 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.
$sel:stageName:ApiGatewayProxyInput'
, apiGatewayProxyInput_stageName
- The name of the API Gateway stage. The name defaults to prod
.
ApiGatewayProxySummary
data ApiGatewayProxySummary Source #
A wrapper object holding the Amazon API Gateway proxy summary.
See: newApiGatewayProxySummary
smart constructor.
ApiGatewayProxySummary' (Maybe Text) (Maybe ApiGatewayEndpointType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newApiGatewayProxySummary :: ApiGatewayProxySummary Source #
Create a value of ApiGatewayProxySummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiGatewayId:ApiGatewayProxySummary'
, apiGatewayProxySummary_apiGatewayId
- The resource ID of the API Gateway for the proxy.
$sel:endpointType:ApiGatewayProxySummary'
, apiGatewayProxySummary_endpointType
- The type of API Gateway endpoint created.
$sel:nlbArn:ApiGatewayProxySummary'
, apiGatewayProxySummary_nlbArn
- The Amazon Resource Name (ARN) of the Network Load Balancer configured
by the API Gateway proxy.
$sel:nlbName:ApiGatewayProxySummary'
, apiGatewayProxySummary_nlbName
- The name of the Network Load Balancer that is configured by the API
Gateway proxy.
$sel:proxyUrl:ApiGatewayProxySummary'
, apiGatewayProxySummary_proxyUrl
- The endpoint URL of the API Gateway proxy.
$sel:stageName:ApiGatewayProxySummary'
, apiGatewayProxySummary_stageName
- The name of the API Gateway stage. The name defaults to prod
.
$sel:vpcLinkId:ApiGatewayProxySummary'
, apiGatewayProxySummary_vpcLinkId
- The VpcLink
ID of the API Gateway proxy.
ApplicationSummary
data ApplicationSummary Source #
The list of ApplicationSummary
objects.
See: newApplicationSummary
smart constructor.
ApplicationSummary' (Maybe ApiGatewayProxySummary) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ProxyType) (Maybe ApplicationState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) |
Instances
newApplicationSummary :: ApplicationSummary Source #
Create a value of ApplicationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiGatewayProxy:ApplicationSummary'
, applicationSummary_apiGatewayProxy
- The endpoint URL of the Amazon API Gateway proxy.
$sel:applicationId:ApplicationSummary'
, applicationSummary_applicationId
- The unique identifier of the application.
$sel:arn:ApplicationSummary'
, applicationSummary_arn
- The Amazon Resource Name (ARN) of the application.
$sel:createdByAccountId:ApplicationSummary'
, applicationSummary_createdByAccountId
- The Amazon Web Services account ID of the application creator.
$sel:createdTime:ApplicationSummary'
, applicationSummary_createdTime
- A timestamp that indicates when the application is created.
$sel:environmentId:ApplicationSummary'
, applicationSummary_environmentId
- The unique identifier of the environment.
$sel:error:ApplicationSummary'
, applicationSummary_error
- Any error associated with the application resource.
$sel:lastUpdatedTime:ApplicationSummary'
, applicationSummary_lastUpdatedTime
- A timestamp that indicates when the application was last updated.
$sel:name:ApplicationSummary'
, applicationSummary_name
- The name of the application.
$sel:ownerAccountId:ApplicationSummary'
, applicationSummary_ownerAccountId
- The Amazon Web Services account ID of the application owner (which is
always the same as the environment owner account ID).
$sel:proxyType:ApplicationSummary'
, applicationSummary_proxyType
- The proxy type of the proxy created within the application.
$sel:state:ApplicationSummary'
, applicationSummary_state
- The current state of the application.
$sel:tags:ApplicationSummary'
, applicationSummary_tags
- The tags assigned to the application.
$sel:vpcId:ApplicationSummary'
, applicationSummary_vpcId
- The ID of the virtual private cloud (VPC).
DefaultRouteInput
data DefaultRouteInput Source #
The configuration for the default route type.
See: newDefaultRouteInput
smart constructor.
Instances
newDefaultRouteInput :: DefaultRouteInput Source #
Create a value of DefaultRouteInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activationState:DefaultRouteInput'
, defaultRouteInput_activationState
- If set to ACTIVE
, traffic is forwarded to this route’s service after
the route is created.
EnvironmentSummary
data EnvironmentSummary Source #
The summary information for environments as a response to
ListEnvironments
.
See: newEnvironmentSummary
smart constructor.
EnvironmentSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ErrorResponse) (Maybe POSIX) (Maybe Text) (Maybe NetworkFabricType) (Maybe Text) (Maybe EnvironmentState) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) |
Instances
newEnvironmentSummary :: EnvironmentSummary Source #
Create a value of EnvironmentSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:EnvironmentSummary'
, environmentSummary_arn
- The Amazon Resource Name (ARN) of the environment.
$sel:createdTime:EnvironmentSummary'
, environmentSummary_createdTime
- A timestamp that indicates when the environment is created.
$sel:description:EnvironmentSummary'
, environmentSummary_description
- A description of the environment.
$sel:environmentId:EnvironmentSummary'
, environmentSummary_environmentId
- The unique identifier of the environment.
$sel:error:EnvironmentSummary'
, environmentSummary_error
- Any error associated with the environment resource.
$sel:lastUpdatedTime:EnvironmentSummary'
, environmentSummary_lastUpdatedTime
- A timestamp that indicates when the environment was last updated.
$sel:name:EnvironmentSummary'
, environmentSummary_name
- The name of the environment.
$sel:networkFabricType:EnvironmentSummary'
, environmentSummary_networkFabricType
- The network fabric type of the environment.
$sel:ownerAccountId:EnvironmentSummary'
, environmentSummary_ownerAccountId
- The Amazon Web Services account ID of the environment owner.
$sel:state:EnvironmentSummary'
, environmentSummary_state
- The current state of the environment.
$sel:tags:EnvironmentSummary'
, environmentSummary_tags
- The tags assigned to the environment.
$sel:transitGatewayId:EnvironmentSummary'
, environmentSummary_transitGatewayId
- The ID of the transit gateway set up by the environment.
EnvironmentVpc
data EnvironmentVpc Source #
Provides summary information for the EnvironmentVpc
resource as a
response to ListEnvironmentVpc
.
See: newEnvironmentVpc
smart constructor.
EnvironmentVpc' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newEnvironmentVpc :: EnvironmentVpc Source #
Create a value of EnvironmentVpc
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:EnvironmentVpc'
, environmentVpc_accountId
- The Amazon Web Services account ID of the virtual private cloud (VPC)
owner.
$sel:cidrBlocks:EnvironmentVpc'
, environmentVpc_cidrBlocks
- The list of Amazon Virtual Private Cloud (Amazon VPC) CIDR blocks.
$sel:createdTime:EnvironmentVpc'
, environmentVpc_createdTime
- A timestamp that indicates when the VPC is first added to the
environment.
$sel:environmentId:EnvironmentVpc'
, environmentVpc_environmentId
- The unique identifier of the environment.
$sel:lastUpdatedTime:EnvironmentVpc'
, environmentVpc_lastUpdatedTime
- A timestamp that indicates when the VPC was last updated by the
environment.
$sel:vpcId:EnvironmentVpc'
, environmentVpc_vpcId
- The ID of the VPC.
$sel:vpcName:EnvironmentVpc'
, environmentVpc_vpcName
- The name of the VPC at the time it is added to the environment.
ErrorResponse
data ErrorResponse Source #
Error associated with a resource returned for a Get or List resource response.
See: newErrorResponse
smart constructor.
ErrorResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe ErrorCode) (Maybe Text) (Maybe Text) (Maybe ErrorResourceType) |
Instances
newErrorResponse :: ErrorResponse Source #
Create a value of ErrorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:ErrorResponse'
, errorResponse_accountId
- The Amazon Web Services account ID of the resource owner.
$sel:additionalDetails:ErrorResponse'
, errorResponse_additionalDetails
- Additional details about the error.
$sel:code:ErrorResponse'
, errorResponse_code
- The error code associated with the error.
$sel:message:ErrorResponse'
, errorResponse_message
- The message associated with the error.
$sel:resourceIdentifier:ErrorResponse'
, errorResponse_resourceIdentifier
- The ID of the resource.
$sel:resourceType:ErrorResponse'
, errorResponse_resourceType
- The type of resource.
LambdaEndpointConfig
data LambdaEndpointConfig Source #
The configuration for the Lambda endpoint type.
See: newLambdaEndpointConfig
smart constructor.
Instances
newLambdaEndpointConfig :: LambdaEndpointConfig Source #
Create a value of LambdaEndpointConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:LambdaEndpointConfig'
, lambdaEndpointConfig_arn
- The Amazon Resource Name (ARN) of the Lambda endpoint.
LambdaEndpointInput
data LambdaEndpointInput Source #
The input for the Lambda endpoint type.
See: newLambdaEndpointInput
smart constructor.
Instances
newLambdaEndpointInput Source #
Create a value of LambdaEndpointInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:LambdaEndpointInput'
, lambdaEndpointInput_arn
- The Amazon Resource Name (ARN) of the Lambda function or alias.
LambdaEndpointSummary
data LambdaEndpointSummary Source #
The summary for the Lambda endpoint type.
See: newLambdaEndpointSummary
smart constructor.
Instances
newLambdaEndpointSummary :: LambdaEndpointSummary Source #
Create a value of LambdaEndpointSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:LambdaEndpointSummary'
, lambdaEndpointSummary_arn
- The Amazon Resource Name (ARN) of the Lambda endpoint.
RouteSummary
data RouteSummary Source #
The summary information for the routes as a response to ListRoutes
.
See: newRouteSummary
smart constructor.
RouteSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ErrorResponse) (Maybe Bool) (Maybe POSIX) (Maybe [HttpMethod]) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe RouteType) (Maybe Text) (Maybe Text) (Maybe RouteState) (Maybe (Sensitive (HashMap Text Text))) |
Instances
newRouteSummary :: RouteSummary Source #
Create a value of RouteSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:RouteSummary'
, routeSummary_applicationId
- The unique identifier of the application.
$sel:arn:RouteSummary'
, routeSummary_arn
- The Amazon Resource Name (ARN) of the route.
$sel:createdByAccountId:RouteSummary'
, routeSummary_createdByAccountId
- The Amazon Web Services account ID of the route creator.
$sel:createdTime:RouteSummary'
, routeSummary_createdTime
- A timestamp that indicates when the route is created.
$sel:environmentId:RouteSummary'
, routeSummary_environmentId
- The unique identifier of the environment.
$sel:error:RouteSummary'
, routeSummary_error
- Any error associated with the route resource.
$sel:includeChildPaths:RouteSummary'
, routeSummary_includeChildPaths
- 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.
$sel:lastUpdatedTime:RouteSummary'
, routeSummary_lastUpdatedTime
- A timestamp that indicates when the route was last updated.
$sel:methods:RouteSummary'
, 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.
$sel:ownerAccountId:RouteSummary'
, routeSummary_ownerAccountId
- The Amazon Web Services account ID of the route owner.
$sel:pathResourceToId:RouteSummary'
, routeSummary_pathResourceToId
- A mapping of Amazon API Gateway path resources to resource IDs.
$sel:routeId:RouteSummary'
, routeSummary_routeId
- The unique identifier of the route.
$sel:routeType:RouteSummary'
, routeSummary_routeType
- The route type of the route.
$sel:serviceId:RouteSummary'
, routeSummary_serviceId
- The unique identifier of the service.
$sel:sourcePath:RouteSummary'
, routeSummary_sourcePath
- The path to use to match traffic. Paths must start with /
and are
relative to the base of the application.
$sel:state:RouteSummary'
, routeSummary_state
- The current state of the route.
$sel:tags:RouteSummary'
, routeSummary_tags
- The tags assigned to the route.
ServiceSummary
data ServiceSummary Source #
A summary for the service as a response to ListServices
.
See: newServiceSummary
smart constructor.
ServiceSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceEndpointType) (Maybe Text) (Maybe ErrorResponse) (Maybe LambdaEndpointSummary) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceState) (Maybe (Sensitive (HashMap Text Text))) (Maybe UrlEndpointSummary) (Maybe Text) |
Instances
newServiceSummary :: ServiceSummary Source #
Create a value of ServiceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationId:ServiceSummary'
, serviceSummary_applicationId
- The unique identifier of the application.
ServiceSummary
, serviceSummary_arn
- The Amazon Resource Name (ARN) of the service.
$sel:createdByAccountId:ServiceSummary'
, serviceSummary_createdByAccountId
- The Amazon Web Services account ID of the service creator.
$sel:createdTime:ServiceSummary'
, serviceSummary_createdTime
- A timestamp that indicates when the service is created.
$sel:description:ServiceSummary'
, serviceSummary_description
- A description of the service.
$sel:endpointType:ServiceSummary'
, serviceSummary_endpointType
- The endpoint type of the service.
$sel:environmentId:ServiceSummary'
, serviceSummary_environmentId
- The unique identifier of the environment.
$sel:error:ServiceSummary'
, serviceSummary_error
- Any error associated with the service resource.
$sel:lambdaEndpoint:ServiceSummary'
, serviceSummary_lambdaEndpoint
- A summary of the configuration for the Lambda endpoint type.
$sel:lastUpdatedTime:ServiceSummary'
, serviceSummary_lastUpdatedTime
- A timestamp that indicates when the service was last updated.
$sel:name:ServiceSummary'
, serviceSummary_name
- The name of the service.
$sel:ownerAccountId:ServiceSummary'
, serviceSummary_ownerAccountId
- The Amazon Web Services account ID of the service owner.
$sel:serviceId:ServiceSummary'
, serviceSummary_serviceId
- The unique identifier of the service.
$sel:state:ServiceSummary'
, serviceSummary_state
- The current state of the service.
$sel:tags:ServiceSummary'
, serviceSummary_tags
- The tags assigned to the service.
$sel:urlEndpoint:ServiceSummary'
, serviceSummary_urlEndpoint
- The summary of the configuration for the URL endpoint type.
$sel:vpcId:ServiceSummary'
, serviceSummary_vpcId
- The ID of the virtual private cloud (VPC).
UriPathRouteInput
data UriPathRouteInput Source #
The configuration for the URI path route type.
See: newUriPathRouteInput
smart constructor.
Instances
Create a value of UriPathRouteInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeChildPaths:UriPathRouteInput'
, uriPathRouteInput_includeChildPaths
- 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.
$sel:methods:UriPathRouteInput'
, 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.
$sel:activationState:UriPathRouteInput'
, uriPathRouteInput_activationState
- If set to ACTIVE
, traffic is forwarded to this route’s service after
the route is created.
$sel:sourcePath:UriPathRouteInput'
, uriPathRouteInput_sourcePath
- The path to use to match traffic. Paths must start with /
and are
relative to the base of the application.
UrlEndpointConfig
data UrlEndpointConfig Source #
The configuration for the URL endpoint type.
See: newUrlEndpointConfig
smart constructor.
Instances
newUrlEndpointConfig :: UrlEndpointConfig Source #
Create a value of UrlEndpointConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:healthUrl:UrlEndpointConfig'
, urlEndpointConfig_healthUrl
- The health check URL of the URL endpoint type.
$sel:url:UrlEndpointConfig'
, urlEndpointConfig_url
- The HTTP URL endpoint.
UrlEndpointInput
data UrlEndpointInput Source #
The configuration for the URL endpoint type.
See: newUrlEndpointInput
smart constructor.
Instances
Create a value of UrlEndpointInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:healthUrl:UrlEndpointInput'
, 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.
$sel:url:UrlEndpointInput'
, urlEndpointInput_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.
UrlEndpointSummary
data UrlEndpointSummary Source #
The summary of the configuration for the URL endpoint type.
See: newUrlEndpointSummary
smart constructor.
Instances
newUrlEndpointSummary :: UrlEndpointSummary Source #
Create a value of UrlEndpointSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:healthUrl:UrlEndpointSummary'
, urlEndpointSummary_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.
$sel:url:UrlEndpointSummary'
, urlEndpointSummary_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.