amazonka-redshift-serverless-2.0: Amazon Redshift Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RedshiftServerLess.ListEndpointAccess

Description

Returns an array of EndpointAccess objects and relevant information.

This operation returns paginated results.

Synopsis

Creating a Request

data ListEndpointAccess Source #

See: newListEndpointAccess smart constructor.

Constructors

ListEndpointAccess' 

Fields

  • maxResults :: Maybe Natural

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • nextToken :: Maybe Text

    If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.

  • vpcId :: Maybe Text

    The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

  • workgroupName :: Maybe Text

    The name of the workgroup associated with the VPC endpoint to return.

Instances

Instances details
ToJSON ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

ToHeaders ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

ToPath ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

ToQuery ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

AWSPager ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

AWSRequest ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Associated Types

type AWSResponse ListEndpointAccess #

Generic ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Associated Types

type Rep ListEndpointAccess :: Type -> Type #

Read ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Show ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

NFData ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Methods

rnf :: ListEndpointAccess -> () #

Eq ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Hashable ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

type AWSResponse ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

type Rep ListEndpointAccess Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

type Rep ListEndpointAccess = D1 ('MetaData "ListEndpointAccess" "Amazonka.RedshiftServerLess.ListEndpointAccess" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListEndpointAccess'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "workgroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListEndpointAccess :: ListEndpointAccess Source #

Create a value of ListEndpointAccess 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:ListEndpointAccess', listEndpointAccess_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

ListEndpointAccess, listEndpointAccess_nextToken - If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.

ListEndpointAccess, listEndpointAccess_vpcId - The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

ListEndpointAccess, listEndpointAccess_workgroupName - The name of the workgroup associated with the VPC endpoint to return.

Request Lenses

listEndpointAccess_maxResults :: Lens' ListEndpointAccess (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

listEndpointAccess_nextToken :: Lens' ListEndpointAccess (Maybe Text) Source #

If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.

listEndpointAccess_vpcId :: Lens' ListEndpointAccess (Maybe Text) Source #

The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

listEndpointAccess_workgroupName :: Lens' ListEndpointAccess (Maybe Text) Source #

The name of the workgroup associated with the VPC endpoint to return.

Destructuring the Response

data ListEndpointAccessResponse Source #

See: newListEndpointAccessResponse smart constructor.

Constructors

ListEndpointAccessResponse' 

Fields

  • nextToken :: Maybe Text

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • httpStatus :: Int

    The response's http status code.

  • endpoints :: [EndpointAccess]

    The returned VPC endpoints.

Instances

Instances details
Generic ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Associated Types

type Rep ListEndpointAccessResponse :: Type -> Type #

Read ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Show ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

NFData ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

Eq ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

type Rep ListEndpointAccessResponse Source # 
Instance details

Defined in Amazonka.RedshiftServerLess.ListEndpointAccess

type Rep ListEndpointAccessResponse = D1 ('MetaData "ListEndpointAccessResponse" "Amazonka.RedshiftServerLess.ListEndpointAccess" "amazonka-redshift-serverless-2.0-ApuSN33KEWs53jvwyBa3sl" 'False) (C1 ('MetaCons "ListEndpointAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EndpointAccess]))))

newListEndpointAccessResponse Source #

Create a value of ListEndpointAccessResponse 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:

ListEndpointAccess, listEndpointAccessResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:httpStatus:ListEndpointAccessResponse', listEndpointAccessResponse_httpStatus - The response's http status code.

$sel:endpoints:ListEndpointAccessResponse', listEndpointAccessResponse_endpoints - The returned VPC endpoints.

Response Lenses

listEndpointAccessResponse_nextToken :: Lens' ListEndpointAccessResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.