| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CognitoSync.DescribeIdentityUsage
Description
Gets usage information for an identity, including number of datasets and data usage.
This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.
Synopsis
- data DescribeIdentityUsage = DescribeIdentityUsage' {
- identityPoolId :: Text
- identityId :: Text
- newDescribeIdentityUsage :: Text -> Text -> DescribeIdentityUsage
- describeIdentityUsage_identityPoolId :: Lens' DescribeIdentityUsage Text
- describeIdentityUsage_identityId :: Lens' DescribeIdentityUsage Text
- data DescribeIdentityUsageResponse = DescribeIdentityUsageResponse' {}
- newDescribeIdentityUsageResponse :: Int -> DescribeIdentityUsageResponse
- describeIdentityUsageResponse_identityUsage :: Lens' DescribeIdentityUsageResponse (Maybe IdentityUsage)
- describeIdentityUsageResponse_httpStatus :: Lens' DescribeIdentityUsageResponse Int
Creating a Request
data DescribeIdentityUsage Source #
A request for information about the usage of an identity pool.
See: newDescribeIdentityUsage smart constructor.
Constructors
| DescribeIdentityUsage' | |
Fields
| |
Instances
newDescribeIdentityUsage Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeIdentityUsage |
Create a value of DescribeIdentityUsage 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:identityPoolId:DescribeIdentityUsage', describeIdentityUsage_identityPoolId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito. GUID generation is unique within a region.
$sel:identityId:DescribeIdentityUsage', describeIdentityUsage_identityId - A name-spaced GUID (for example,
us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon
Cognito. GUID generation is unique within a region.
Request Lenses
describeIdentityUsage_identityPoolId :: Lens' DescribeIdentityUsage Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
describeIdentityUsage_identityId :: Lens' DescribeIdentityUsage Text Source #
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
Destructuring the Response
data DescribeIdentityUsageResponse Source #
The response to a successful DescribeIdentityUsage request.
See: newDescribeIdentityUsageResponse smart constructor.
Constructors
| DescribeIdentityUsageResponse' | |
Fields
| |
Instances
newDescribeIdentityUsageResponse Source #
Create a value of DescribeIdentityUsageResponse 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:identityUsage:DescribeIdentityUsageResponse', describeIdentityUsageResponse_identityUsage - Usage information for the identity.
$sel:httpStatus:DescribeIdentityUsageResponse', describeIdentityUsageResponse_httpStatus - The response's http status code.
Response Lenses
describeIdentityUsageResponse_identityUsage :: Lens' DescribeIdentityUsageResponse (Maybe IdentityUsage) Source #
Usage information for the identity.
describeIdentityUsageResponse_httpStatus :: Lens' DescribeIdentityUsageResponse Int Source #
The response's http status code.