| 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.FraudDetector.GetEntityTypes
Description
Gets all entity types or a specific entity type if a name is specified.
This is a paginated API. If you provide a null maxResults, this action
retrieves a maximum of 10 records per page. If you provide a
maxResults, the value must be between 5 and 10. To get the next page
results, provide the pagination token from the GetEntityTypesResponse
as part of your request. A null pagination token fetches the records
from the beginning.
Synopsis
- data GetEntityTypes = GetEntityTypes' {}
- newGetEntityTypes :: GetEntityTypes
- getEntityTypes_nextToken :: Lens' GetEntityTypes (Maybe Text)
- getEntityTypes_name :: Lens' GetEntityTypes (Maybe Text)
- getEntityTypes_maxResults :: Lens' GetEntityTypes (Maybe Natural)
- data GetEntityTypesResponse = GetEntityTypesResponse' {
- entityTypes :: Maybe [EntityType]
- nextToken :: Maybe Text
- httpStatus :: Int
- newGetEntityTypesResponse :: Int -> GetEntityTypesResponse
- getEntityTypesResponse_entityTypes :: Lens' GetEntityTypesResponse (Maybe [EntityType])
- getEntityTypesResponse_nextToken :: Lens' GetEntityTypesResponse (Maybe Text)
- getEntityTypesResponse_httpStatus :: Lens' GetEntityTypesResponse Int
Creating a Request
data GetEntityTypes Source #
See: newGetEntityTypes smart constructor.
Constructors
| GetEntityTypes' | |
Instances
newGetEntityTypes :: GetEntityTypes Source #
Create a value of GetEntityTypes 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:nextToken:GetEntityTypes', getEntityTypes_nextToken - The next token for the subsequent request.
$sel:name:GetEntityTypes', getEntityTypes_name - The name.
$sel:maxResults:GetEntityTypes', getEntityTypes_maxResults - The maximum number of objects to return for the request.
Request Lenses
getEntityTypes_nextToken :: Lens' GetEntityTypes (Maybe Text) Source #
The next token for the subsequent request.
getEntityTypes_name :: Lens' GetEntityTypes (Maybe Text) Source #
The name.
getEntityTypes_maxResults :: Lens' GetEntityTypes (Maybe Natural) Source #
The maximum number of objects to return for the request.
Destructuring the Response
data GetEntityTypesResponse Source #
See: newGetEntityTypesResponse smart constructor.
Constructors
| GetEntityTypesResponse' | |
Fields
| |
Instances
newGetEntityTypesResponse Source #
Create a value of GetEntityTypesResponse 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:entityTypes:GetEntityTypesResponse', getEntityTypesResponse_entityTypes - An array of entity types.
$sel:nextToken:GetEntityTypes', getEntityTypesResponse_nextToken - The next page token.
$sel:httpStatus:GetEntityTypesResponse', getEntityTypesResponse_httpStatus - The response's http status code.
Response Lenses
getEntityTypesResponse_entityTypes :: Lens' GetEntityTypesResponse (Maybe [EntityType]) Source #
An array of entity types.
getEntityTypesResponse_nextToken :: Lens' GetEntityTypesResponse (Maybe Text) Source #
The next page token.
getEntityTypesResponse_httpStatus :: Lens' GetEntityTypesResponse Int Source #
The response's http status code.