Network.AWS.APIGateway.GetAccount

Gets information about the current Account resource.

Creating a Request

getAccount :: GetAccount

Creates a value of GetAccount with the minimum fields required to make a request.

data GetAccount

Requests Amazon API Gateway to get information about the current Account resource.

See: getAccount smart constructor.

Instances

Eq GetAccount

Methods

(==) :: GetAccount -> GetAccount -> Bool

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

Data GetAccount

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetAccount -> c GetAccount

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetAccount

toConstr :: GetAccount -> Constr

dataTypeOf :: GetAccount -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetAccount)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetAccount)

gmapT :: (forall b. Data b => b -> b) -> GetAccount -> GetAccount

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetAccount -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetAccount -> r

gmapQ :: (forall d. Data d => d -> u) -> GetAccount -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetAccount -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAccount -> m GetAccount

Read GetAccount

Methods

readsPrec :: Int -> ReadS GetAccount

readList :: ReadS [GetAccount]

readPrec :: ReadPrec GetAccount

readListPrec :: ReadPrec [GetAccount]

Show GetAccount

Methods

showsPrec :: Int -> GetAccount -> ShowS

show :: GetAccount -> String

showList :: [GetAccount] -> ShowS

Generic GetAccount

Associated Types

type Rep GetAccount :: * -> *

Methods

from :: GetAccount -> Rep GetAccount x

to :: Rep GetAccount x -> GetAccount

Hashable GetAccount

Methods

hashWithSalt :: Int -> GetAccount -> Int

hash :: GetAccount -> Int

NFData GetAccount

Methods

rnf :: GetAccount -> ()

AWSRequest GetAccount

Associated Types

type Rs GetAccount :: *

Methods

request :: GetAccount -> Request GetAccount

response :: MonadResource m => Logger -> Service -> Proxy * GetAccount -> ClientResponse -> m (Response GetAccount)

ToQuery GetAccount

Methods

toQuery :: GetAccount -> QueryString

ToPath GetAccount

Methods

toPath :: GetAccount -> ByteString

ToHeaders GetAccount

Methods

toHeaders :: GetAccount -> [Header]

type Rep GetAccount

type Rep GetAccount = D1 (MetaData "GetAccount" "Network.AWS.APIGateway.GetAccount" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetAccount'" PrefixI False) U1)

type Rs GetAccount

type Rs GetAccount = Account

Destructuring the Response

account :: Account

Creates a value of Account with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aApiKeyVersion - The version of the API keys used for the account.
• aCloudwatchRoleARN - The ARN of an Amazon CloudWatch role for the current Account .
• aFeatures - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of UsagePlans .
• aThrottleSettings - Specifies the API request limits configured for the current Account .

data Account

Represents an AWS account that is associated with Amazon API Gateway.

To view the account info, call GET on this resource.

Error Codes The following exception may be thrown when the request fails.

• UnauthorizedException * NotFoundException * TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account. Request @GET account HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK@ status code and a payload similar to the following:

@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "account" }, "account:update": { "href": "account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } @ In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide , AWS CLI

See: account smart constructor.

Instances

Eq Account

Methods

(==) :: Account -> Account -> Bool

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

Data Account

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Account -> c Account

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Account

toConstr :: Account -> Constr

dataTypeOf :: Account -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Account)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Account)

gmapT :: (forall b. Data b => b -> b) -> Account -> Account

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r

gmapQ :: (forall d. Data d => d -> u) -> Account -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Account -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Account -> m Account

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account

Read Account

Methods

readsPrec :: Int -> ReadS Account

readList :: ReadS [Account]

readPrec :: ReadPrec Account

readListPrec :: ReadPrec [Account]

Show Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

Generic Account

Associated Types

type Rep Account :: * -> *

Methods

from :: Account -> Rep Account x

to :: Rep Account x -> Account

Hashable Account

Methods

hashWithSalt :: Int -> Account -> Int

hash :: Account -> Int

FromJSON Account

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

NFData Account

Methods

rnf :: Account -> ()

type Rep Account

type Rep Account = D1 (MetaData "Account" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Account'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aApiKeyVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aCloudwatchRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aFeatures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_aThrottleSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

Response Lenses

aApiKeyVersion :: Lens' Account (Maybe Text)

The version of the API keys used for the account.

aCloudwatchRoleARN :: Lens' Account (Maybe Text)

The ARN of an Amazon CloudWatch role for the current Account .

aFeatures :: Lens' Account [Text]

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of UsagePlans .

aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)

Specifies the API request limits configured for the current Account .