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

Amazonka.WorkSpaces.DescribeConnectionAliases

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Synopsis

Creating a Request

data DescribeConnectionAliases Source #

See: newDescribeConnectionAliases smart constructor.

Constructors

DescribeConnectionAliases'

Fields

aliasIds :: Maybe (NonEmpty Text)
The identifiers of the connection aliases to describe.
limit :: Maybe Natural
The maximum number of connection aliases to return.
nextToken :: Maybe Text
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
resourceId :: Maybe Text
The identifier of the directory associated with the connection alias.

Instances

Instances details

ToJSON DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods toJSON :: DescribeConnectionAliases -> Value # toEncoding :: DescribeConnectionAliases -> Encoding # toJSONList :: [DescribeConnectionAliases] -> Value # toEncodingList :: [DescribeConnectionAliases] -> Encoding #
ToHeaders DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods toHeaders :: DescribeConnectionAliases -> [Header] #
ToPath DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods toPath :: DescribeConnectionAliases -> ByteString #
ToQuery DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods toQuery :: DescribeConnectionAliases -> QueryString #
AWSRequest DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Associated Types type AWSResponse DescribeConnectionAliases # Methods request :: (Service -> Service) -> DescribeConnectionAliases -> Request DescribeConnectionAliases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeConnectionAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeConnectionAliases))) #
Generic DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Associated Types type Rep DescribeConnectionAliases :: Type -> Type # Methods from :: DescribeConnectionAliases -> Rep DescribeConnectionAliases x # to :: Rep DescribeConnectionAliases x -> DescribeConnectionAliases #
Read DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods readsPrec :: Int -> ReadS DescribeConnectionAliases # readList :: ReadS [DescribeConnectionAliases] # readPrec :: ReadPrec DescribeConnectionAliases # readListPrec :: ReadPrec [DescribeConnectionAliases] #
Show DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods showsPrec :: Int -> DescribeConnectionAliases -> ShowS # show :: DescribeConnectionAliases -> String # showList :: [DescribeConnectionAliases] -> ShowS #
NFData DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods rnf :: DescribeConnectionAliases -> () #
Eq DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods (==) :: DescribeConnectionAliases -> DescribeConnectionAliases -> Bool # (/=) :: DescribeConnectionAliases -> DescribeConnectionAliases -> Bool #
Hashable DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods hashWithSalt :: Int -> DescribeConnectionAliases -> Int # hash :: DescribeConnectionAliases -> Int #
type AWSResponse DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases type AWSResponse DescribeConnectionAliases = DescribeConnectionAliasesResponse
type Rep DescribeConnectionAliases Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases type Rep DescribeConnectionAliases = D1 ('MetaData "DescribeConnectionAliases" "Amazonka.WorkSpaces.DescribeConnectionAliases" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeConnectionAliases'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeConnectionAliases :: DescribeConnectionAliases Source #

Create a value of DescribeConnectionAliases 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:aliasIds:DescribeConnectionAliases', describeConnectionAliases_aliasIds - The identifiers of the connection aliases to describe.

$sel:limit:DescribeConnectionAliases', describeConnectionAliases_limit - The maximum number of connection aliases to return.

DescribeConnectionAliases, describeConnectionAliases_nextToken - If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

DescribeConnectionAliases, describeConnectionAliases_resourceId - The identifier of the directory associated with the connection alias.

Request Lenses

describeConnectionAliases_aliasIds :: Lens' DescribeConnectionAliases (Maybe (NonEmpty Text)) Source #

The identifiers of the connection aliases to describe.

describeConnectionAliases_limit :: Lens' DescribeConnectionAliases (Maybe Natural) Source #

The maximum number of connection aliases to return.

describeConnectionAliases_nextToken :: Lens' DescribeConnectionAliases (Maybe Text) Source #

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

describeConnectionAliases_resourceId :: Lens' DescribeConnectionAliases (Maybe Text) Source #

The identifier of the directory associated with the connection alias.

Destructuring the Response

data DescribeConnectionAliasesResponse Source #

See: newDescribeConnectionAliasesResponse smart constructor.

Constructors

DescribeConnectionAliasesResponse'
Fields connectionAliases :: Maybe (NonEmpty ConnectionAlias) Information about the specified connection aliases. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is null when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Associated Types type Rep DescribeConnectionAliasesResponse :: Type -> Type # Methods from :: DescribeConnectionAliasesResponse -> Rep DescribeConnectionAliasesResponse x # to :: Rep DescribeConnectionAliasesResponse x -> DescribeConnectionAliasesResponse #
Read DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods readsPrec :: Int -> ReadS DescribeConnectionAliasesResponse # readList :: ReadS [DescribeConnectionAliasesResponse] # readPrec :: ReadPrec DescribeConnectionAliasesResponse # readListPrec :: ReadPrec [DescribeConnectionAliasesResponse] #
Show DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods showsPrec :: Int -> DescribeConnectionAliasesResponse -> ShowS # show :: DescribeConnectionAliasesResponse -> String # showList :: [DescribeConnectionAliasesResponse] -> ShowS #
NFData DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods rnf :: DescribeConnectionAliasesResponse -> () #
Eq DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases Methods (==) :: DescribeConnectionAliasesResponse -> DescribeConnectionAliasesResponse -> Bool # (/=) :: DescribeConnectionAliasesResponse -> DescribeConnectionAliasesResponse -> Bool #
type Rep DescribeConnectionAliasesResponse Source #
Instance details Defined in Amazonka.WorkSpaces.DescribeConnectionAliases type Rep DescribeConnectionAliasesResponse = D1 ('MetaData "DescribeConnectionAliasesResponse" "Amazonka.WorkSpaces.DescribeConnectionAliases" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DescribeConnectionAliasesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionAliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConnectionAlias))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConnectionAliasesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeConnectionAliasesResponse'`
-> DescribeConnectionAliasesResponse

Create a value of DescribeConnectionAliasesResponse 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:connectionAliases:DescribeConnectionAliasesResponse', describeConnectionAliasesResponse_connectionAliases - Information about the specified connection aliases.

DescribeConnectionAliases, describeConnectionAliasesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeConnectionAliasesResponse', describeConnectionAliasesResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectionAliasesResponse_connectionAliases :: Lens' DescribeConnectionAliasesResponse (Maybe (NonEmpty ConnectionAlias)) Source #

Information about the specified connection aliases.

describeConnectionAliasesResponse_nextToken :: Lens' DescribeConnectionAliasesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeConnectionAliasesResponse_httpStatus :: Lens' DescribeConnectionAliasesResponse Int Source #

The response's http status code.