Amazonka.MigrationHubReFactorSpaces.GetRoute

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Creating a Request

data GetRoute

See: newGetRoute smart constructor.

Constructors

GetRoute'

Fields

• applicationIdentifier :: Text

  The ID of the application.

• environmentIdentifier :: Text

  The ID of the environment.

• routeIdentifier :: Text

  The ID of the route.

Instances

ToHeaders GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

toHeaders :: GetRoute -> [Header]

ToPath GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

toPath :: GetRoute -> ByteString

ToQuery GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

toQuery :: GetRoute -> QueryString

AWSRequest GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Associated Types

type AWSResponse GetRoute

Methods

request :: (Service -> Service) -> GetRoute -> Request GetRoute

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRoute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRoute)))

Generic GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Associated Types

type Rep GetRoute :: Type -> Type

Methods

from :: GetRoute -> Rep GetRoute x

to :: Rep GetRoute x -> GetRoute

Read GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

readsPrec :: Int -> ReadS GetRoute

readList :: ReadS [GetRoute]

readPrec :: ReadPrec GetRoute

readListPrec :: ReadPrec [GetRoute]

Show GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

showsPrec :: Int -> GetRoute -> ShowS

show :: GetRoute -> String

showList :: [GetRoute] -> ShowS

NFData GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

rnf :: GetRoute -> ()

Eq GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

(==) :: GetRoute -> GetRoute -> Bool

(/=) :: GetRoute -> GetRoute -> Bool

Hashable GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

hashWithSalt :: Int -> GetRoute -> Int

hash :: GetRoute -> Int

type AWSResponse GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

type AWSResponse GetRoute = GetRouteResponse

type Rep GetRoute

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

type Rep GetRoute = D1 ('MetaData "GetRoute" "Amazonka.MigrationHubReFactorSpaces.GetRoute" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "GetRoute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "environmentIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routeIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetRoute

Arguments

:: Text

$sel:applicationIdentifier:GetRoute'

-> Text

$sel:environmentIdentifier:GetRoute'

-> Text

$sel:routeIdentifier:GetRoute'

-> GetRoute

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.

Request Lenses

getRoute_applicationIdentifier :: Lens' GetRoute Text

The ID of the application.

getRoute_environmentIdentifier :: Lens' GetRoute Text

The ID of the environment.

getRoute_routeIdentifier :: Lens' GetRoute Text

The ID of the route.

Destructuring the Response

data GetRouteResponse

See: newGetRouteResponse smart constructor.

Constructors

GetRouteResponse'

Fields

• applicationId :: Maybe Text

  The ID of the application that the route belongs to.

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the route.

• createdByAccountId :: Maybe Text

  The Amazon Web Services account ID of the route creator.

• createdTime :: Maybe POSIX

  The timestamp of when the route is created.

• environmentId :: Maybe Text

  Unique identifier of the environment.

• error :: Maybe ErrorResponse

  Any error associated with the route resource.

• includeChildPaths :: Maybe Bool

  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.

• lastUpdatedTime :: Maybe POSIX

  A timestamp that indicates when the route was last updated.

• methods :: Maybe [HttpMethod]

  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.

• ownerAccountId :: Maybe Text

  The Amazon Web Services account ID of the route owner.

• pathResourceToId :: Maybe (HashMap Text Text)

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

• routeId :: Maybe Text

  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.

• routeType :: Maybe RouteType

  The type of route.

• serviceId :: Maybe Text

  The unique identifier of the service.

• sourcePath :: Maybe Text

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

• state :: Maybe RouteState

  The current state of the route.

• tags :: Maybe (Sensitive (HashMap Text Text))

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetRouteResponse

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Associated Types

type Rep GetRouteResponse :: Type -> Type

Methods

from :: GetRouteResponse -> Rep GetRouteResponse x

to :: Rep GetRouteResponse x -> GetRouteResponse

Show GetRouteResponse

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

showsPrec :: Int -> GetRouteResponse -> ShowS

show :: GetRouteResponse -> String

showList :: [GetRouteResponse] -> ShowS

NFData GetRouteResponse

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

rnf :: GetRouteResponse -> ()

Eq GetRouteResponse

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

Methods

(==) :: GetRouteResponse -> GetRouteResponse -> Bool

(/=) :: GetRouteResponse -> GetRouteResponse -> Bool

type Rep GetRouteResponse

Defined in Amazonka.MigrationHubReFactorSpaces.GetRoute

type Rep GetRouteResponse = D1 ('MetaData "GetRouteResponse" "Amazonka.MigrationHubReFactorSpaces.GetRoute" "amazonka-migration-hub-refactor-spaces-2.0-IgAA0SWWxlS8R7imIzpgpS" 'False) (C1 ('MetaCons "GetRouteResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "createdByAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorResponse))) :*: (S1 ('MetaSel ('Just "includeChildPaths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "lastUpdatedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "methods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HttpMethod])))))) :*: (((S1 ('MetaSel ('Just "ownerAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pathResourceToId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "routeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteType)))) :*: ((S1 ('MetaSel ('Just "serviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourcePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RouteState)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetRouteResponse

Arguments

:: Int

$sel:httpStatus:GetRouteResponse'

-> GetRouteResponse

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.

Response Lenses

getRouteResponse_applicationId :: Lens' GetRouteResponse (Maybe Text)

The ID of the application that the route belongs to.

getRouteResponse_arn :: Lens' GetRouteResponse (Maybe Text)

The Amazon Resource Name (ARN) of the route.

getRouteResponse_createdByAccountId :: Lens' GetRouteResponse (Maybe Text)

The Amazon Web Services account ID of the route creator.

getRouteResponse_createdTime :: Lens' GetRouteResponse (Maybe UTCTime)

The timestamp of when the route is created.

getRouteResponse_environmentId :: Lens' GetRouteResponse (Maybe Text)

Unique identifier of the environment.

getRouteResponse_error :: Lens' GetRouteResponse (Maybe ErrorResponse)

Any error associated with the route resource.

getRouteResponse_includeChildPaths :: Lens' GetRouteResponse (Maybe Bool)

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

getRouteResponse_lastUpdatedTime :: Lens' GetRouteResponse (Maybe UTCTime)

A timestamp that indicates when the route was last updated.

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

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

getRouteResponse_ownerAccountId :: Lens' GetRouteResponse (Maybe Text)

The Amazon Web Services account ID of the route owner.

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

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

getRouteResponse_routeId :: Lens' GetRouteResponse (Maybe Text)

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_routeType :: Lens' GetRouteResponse (Maybe RouteType)

The type of route.

getRouteResponse_serviceId :: Lens' GetRouteResponse (Maybe Text)

The unique identifier of the service.

getRouteResponse_sourcePath :: Lens' GetRouteResponse (Maybe Text)

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

getRouteResponse_state :: Lens' GetRouteResponse (Maybe RouteState)

The current state of the route.

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

The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

getRouteResponse_httpStatus :: Lens' GetRouteResponse Int

The response's http status code.