Amazonka.AppSync.ListApiKeys

Lists the API keys for a given API.

API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

This operation returns paginated results.

Creating a Request

data ListApiKeys

See: newListApiKeys smart constructor.

Constructors

ListApiKeys'

Fields

• maxResults :: Maybe Natural

  The maximum number of results that you want the request to return.

• nextToken :: Maybe Text

  An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

• apiId :: Text

  The API ID.

Instances

ToHeaders ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

toHeaders :: ListApiKeys -> [Header]

ToPath ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

toPath :: ListApiKeys -> ByteString

ToQuery ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

toQuery :: ListApiKeys -> QueryString

AWSPager ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

page :: ListApiKeys -> AWSResponse ListApiKeys -> Maybe ListApiKeys

AWSRequest ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Associated Types

type AWSResponse ListApiKeys

Methods

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

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

Generic ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Associated Types

type Rep ListApiKeys :: Type -> Type

Methods

from :: ListApiKeys -> Rep ListApiKeys x

to :: Rep ListApiKeys x -> ListApiKeys

Read ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

readsPrec :: Int -> ReadS ListApiKeys

readList :: ReadS [ListApiKeys]

readPrec :: ReadPrec ListApiKeys

readListPrec :: ReadPrec [ListApiKeys]

Show ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

showsPrec :: Int -> ListApiKeys -> ShowS

show :: ListApiKeys -> String

showList :: [ListApiKeys] -> ShowS

NFData ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

rnf :: ListApiKeys -> ()

Eq ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

(==) :: ListApiKeys -> ListApiKeys -> Bool

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

Hashable ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

Methods

hashWithSalt :: Int -> ListApiKeys -> Int

hash :: ListApiKeys -> Int

type AWSResponse ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

type AWSResponse ListApiKeys = ListApiKeysResponse

type Rep ListApiKeys

Defined in Amazonka.AppSync.ListApiKeys

type Rep ListApiKeys = D1 ('MetaData "ListApiKeys" "Amazonka.AppSync.ListApiKeys" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ListApiKeys'" '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 "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListApiKeys

Arguments

:: Text

ListApiKeys

-> ListApiKeys

Create a value of ListApiKeys 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:ListApiKeys', listApiKeys_maxResults - The maximum number of results that you want the request to return.

ListApiKeys, listApiKeys_nextToken - An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

ListApiKeys, listApiKeys_apiId - The API ID.

Request Lenses

listApiKeys_maxResults :: Lens' ListApiKeys (Maybe Natural)

The maximum number of results that you want the request to return.

listApiKeys_nextToken :: Lens' ListApiKeys (Maybe Text)

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

listApiKeys_apiId :: Lens' ListApiKeys Text

The API ID.

Destructuring the Response

data ListApiKeysResponse

See: newListApiKeysResponse smart constructor.

Constructors

ListApiKeysResponse'

Fields

• apiKeys :: Maybe [ApiKey]

  The ApiKey objects.

• nextToken :: Maybe Text

  An identifier to pass in the next request to this operation to return the next set of items in the list.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

Associated Types

type Rep ListApiKeysResponse :: Type -> Type

Methods

from :: ListApiKeysResponse -> Rep ListApiKeysResponse x

to :: Rep ListApiKeysResponse x -> ListApiKeysResponse

Read ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

Methods

readsPrec :: Int -> ReadS ListApiKeysResponse

readList :: ReadS [ListApiKeysResponse]

readPrec :: ReadPrec ListApiKeysResponse

readListPrec :: ReadPrec [ListApiKeysResponse]

Show ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

Methods

showsPrec :: Int -> ListApiKeysResponse -> ShowS

show :: ListApiKeysResponse -> String

showList :: [ListApiKeysResponse] -> ShowS

NFData ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

Methods

rnf :: ListApiKeysResponse -> ()

Eq ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

Methods

(==) :: ListApiKeysResponse -> ListApiKeysResponse -> Bool

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

type Rep ListApiKeysResponse

Defined in Amazonka.AppSync.ListApiKeys

type Rep ListApiKeysResponse = D1 ('MetaData "ListApiKeysResponse" "Amazonka.AppSync.ListApiKeys" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "ListApiKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiKey])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListApiKeysResponse

Arguments

:: Int

$sel:httpStatus:ListApiKeysResponse'

-> ListApiKeysResponse

Create a value of ListApiKeysResponse 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:apiKeys:ListApiKeysResponse', listApiKeysResponse_apiKeys - The ApiKey objects.

ListApiKeys, listApiKeysResponse_nextToken - An identifier to pass in the next request to this operation to return the next set of items in the list.

$sel:httpStatus:ListApiKeysResponse', listApiKeysResponse_httpStatus - The response's http status code.

Response Lenses

listApiKeysResponse_apiKeys :: Lens' ListApiKeysResponse (Maybe [ApiKey])

The ApiKey objects.

listApiKeysResponse_nextToken :: Lens' ListApiKeysResponse (Maybe Text)

An identifier to pass in the next request to this operation to return the next set of items in the list.

listApiKeysResponse_httpStatus :: Lens' ListApiKeysResponse Int

The response's http status code.