libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.GetAuthorizers

Description

Describe an existing Authorizers resource.

AWS CLI

This operation returns paginated results.

Synopsis

Creating a Request

data GetAuthorizers Source #

Request to describe an existing Authorizers resource.

See: newGetAuthorizers smart constructor.

Constructors

GetAuthorizers' 

Fields

  • limit :: Maybe Int

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

  • position :: Maybe Text

    The current pagination position in the paged result set.

  • restApiId :: Text
    Required
    The string identifier of the associated RestApi.

Instances

Instances details
Eq GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Read GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Show GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Generic GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Associated Types

type Rep GetAuthorizers :: Type -> Type #

NFData GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Methods

rnf :: GetAuthorizers -> () #

Hashable GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

AWSPager GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

AWSRequest GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Associated Types

type AWSResponse GetAuthorizers #

ToHeaders GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

ToPath GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

ToQuery GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

type Rep GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

type Rep GetAuthorizers = D1 ('MetaData "GetAuthorizers" "Amazonka.APIGateway.GetAuthorizers" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetAuthorizers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetAuthorizers Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

newGetAuthorizers Source #

Create a value of GetAuthorizers 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:limit:GetAuthorizers', getAuthorizers_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetAuthorizers', getAuthorizers_position - The current pagination position in the paged result set.

$sel:restApiId:GetAuthorizers', getAuthorizers_restApiId - [Required] The string identifier of the associated RestApi.

Request Lenses

getAuthorizers_limit :: Lens' GetAuthorizers (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getAuthorizers_position :: Lens' GetAuthorizers (Maybe Text) Source #

The current pagination position in the paged result set.

getAuthorizers_restApiId :: Lens' GetAuthorizers Text Source #

Required
The string identifier of the associated RestApi.

Destructuring the Response

data GetAuthorizersResponse Source #

Represents a collection of Authorizer resources.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

See: newGetAuthorizersResponse smart constructor.

Constructors

GetAuthorizersResponse' 

Fields

Instances

Instances details
Eq GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Read GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Show GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Generic GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Associated Types

type Rep GetAuthorizersResponse :: Type -> Type #

NFData GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

Methods

rnf :: GetAuthorizersResponse -> () #

type Rep GetAuthorizersResponse Source # 
Instance details

Defined in Amazonka.APIGateway.GetAuthorizers

type Rep GetAuthorizersResponse = D1 ('MetaData "GetAuthorizersResponse" "Amazonka.APIGateway.GetAuthorizers" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetAuthorizersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Authorizer])) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAuthorizersResponse Source #

Create a value of GetAuthorizersResponse 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:items:GetAuthorizersResponse', getAuthorizersResponse_items - The current page of elements from this collection.

$sel:position:GetAuthorizers', getAuthorizersResponse_position - Undocumented member.

$sel:httpStatus:GetAuthorizersResponse', getAuthorizersResponse_httpStatus - The response's http status code.

Response Lenses

getAuthorizersResponse_items :: Lens' GetAuthorizersResponse (Maybe [Authorizer]) Source #

The current page of elements from this collection.