Amazonka.APIGateway.GetUsage

Gets the usage data of a usage plan in a specified time interval.

This operation returns paginated results.

Creating a Request

data GetUsage

The GET request to get the usage data of a usage plan in a specified time interval.

See: newGetUsage smart constructor.

Constructors

GetUsage'

Fields

• keyId :: Maybe Text

  The Id of the API key associated with the resultant usage data.

• 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.

• usagePlanId :: Text

  The Id of the usage plan associated with the usage data.

• startDate :: Text

  The starting date (e.g., 2016-01-01) of the usage data.

• endDate :: Text

  The ending date (e.g., 2016-12-31) of the usage data.

Instances

ToHeaders GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

toHeaders :: GetUsage -> [Header]

ToPath GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

toPath :: GetUsage -> ByteString

ToQuery GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

toQuery :: GetUsage -> QueryString

AWSPager GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

page :: GetUsage -> AWSResponse GetUsage -> Maybe GetUsage

AWSRequest GetUsage

Defined in Amazonka.APIGateway.GetUsage

Associated Types

type AWSResponse GetUsage

Methods

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

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

Generic GetUsage

Defined in Amazonka.APIGateway.GetUsage

Associated Types

type Rep GetUsage :: Type -> Type

Methods

from :: GetUsage -> Rep GetUsage x

to :: Rep GetUsage x -> GetUsage

Read GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

readsPrec :: Int -> ReadS GetUsage

readList :: ReadS [GetUsage]

readPrec :: ReadPrec GetUsage

readListPrec :: ReadPrec [GetUsage]

Show GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

showsPrec :: Int -> GetUsage -> ShowS

show :: GetUsage -> String

showList :: [GetUsage] -> ShowS

NFData GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

rnf :: GetUsage -> ()

Eq GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

(==) :: GetUsage -> GetUsage -> Bool

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

Hashable GetUsage

Defined in Amazonka.APIGateway.GetUsage

Methods

hashWithSalt :: Int -> GetUsage -> Int

hash :: GetUsage -> Int

type AWSResponse GetUsage

Defined in Amazonka.APIGateway.GetUsage

type AWSResponse GetUsage = Usage

type Rep GetUsage

Defined in Amazonka.APIGateway.GetUsage

type Rep GetUsage = D1 ('MetaData "GetUsage" "Amazonka.APIGateway.GetUsage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetUsage

Arguments

:: Text

GetUsage

-> Text

GetUsage

-> Text

GetUsage

-> GetUsage

Create a value of GetUsage 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:keyId:GetUsage', getUsage_keyId - The Id of the API key associated with the resultant usage data.

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

GetUsage, getUsage_position - The current pagination position in the paged result set.

GetUsage, getUsage_usagePlanId - The Id of the usage plan associated with the usage data.

GetUsage, getUsage_startDate - The starting date (e.g., 2016-01-01) of the usage data.

GetUsage, getUsage_endDate - The ending date (e.g., 2016-12-31) of the usage data.

Request Lenses

getUsage_keyId :: Lens' GetUsage (Maybe Text)

The Id of the API key associated with the resultant usage data.

getUsage_limit :: Lens' GetUsage (Maybe Int)

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

getUsage_position :: Lens' GetUsage (Maybe Text)

The current pagination position in the paged result set.

getUsage_usagePlanId :: Lens' GetUsage Text

The Id of the usage plan associated with the usage data.

getUsage_startDate :: Lens' GetUsage Text

The starting date (e.g., 2016-01-01) of the usage data.

getUsage_endDate :: Lens' GetUsage Text

The ending date (e.g., 2016-12-31) of the usage data.

Destructuring the Response

data Usage

Represents the usage data of a usage plan.

See: newUsage smart constructor.

Constructors

Usage'

Fields

• endDate :: Maybe Text

  The ending date of the usage data.

• items :: Maybe (HashMap Text [[Integer]])

  The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

• position :: Maybe Text
• startDate :: Maybe Text

  The starting date of the usage data.

• usagePlanId :: Maybe Text

  The plan Id associated with this usage data.

Instances

FromJSON Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

parseJSON :: Value -> Parser Usage

parseJSONList :: Value -> Parser [Usage]

Generic Usage

Defined in Amazonka.APIGateway.Types.Usage

Associated Types

type Rep Usage :: Type -> Type

Methods

from :: Usage -> Rep Usage x

to :: Rep Usage x -> Usage

Read Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

readsPrec :: Int -> ReadS Usage

readList :: ReadS [Usage]

readPrec :: ReadPrec Usage

readListPrec :: ReadPrec [Usage]

Show Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

NFData Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

rnf :: Usage -> ()

Eq Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

(==) :: Usage -> Usage -> Bool

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

Hashable Usage

Defined in Amazonka.APIGateway.Types.Usage

Methods

hashWithSalt :: Int -> Usage -> Int

hash :: Usage -> Int

type Rep Usage

Defined in Amazonka.APIGateway.Types.Usage

type Rep Usage = D1 ('MetaData "Usage" "Amazonka.APIGateway.Types.Usage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Usage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [[Integer]])))) :*: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUsage :: Usage

Create a value of Usage 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:endDate:Usage', usage_endDate - The ending date of the usage data.

$sel:items:Usage', usage_items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

$sel:position:Usage', usage_position - Undocumented member.

$sel:startDate:Usage', usage_startDate - The starting date of the usage data.

$sel:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.

Response Lenses

usage_endDate :: Lens' Usage (Maybe Text)

The ending date of the usage data.

usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]]))

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

usage_position :: Lens' Usage (Maybe Text)

Undocumented member.

usage_startDate :: Lens' Usage (Maybe Text)

The starting date of the usage data.

usage_usagePlanId :: Lens' Usage (Maybe Text)

The plan Id associated with this usage data.