mypydantic.models.cognito_identity

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Mapping, Optional, Sequence
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class CognitoIdentityProviderModel(BaseModel):
 14    provider_name: Optional[str] = Field(default=None, alias="ProviderName")
 15    client_id: Optional[str] = Field(default=None, alias="ClientId")
 16    server_side_token_check: Optional[bool] = Field(
 17        default=None, alias="ServerSideTokenCheck"
 18    )
 19
 20
 21class CredentialsModel(BaseModel):
 22    access_key_id: Optional[str] = Field(default=None, alias="AccessKeyId")
 23    secret_key: Optional[str] = Field(default=None, alias="SecretKey")
 24    session_token: Optional[str] = Field(default=None, alias="SessionToken")
 25    expiration: Optional[datetime] = Field(default=None, alias="Expiration")
 26
 27
 28class DeleteIdentitiesInputRequestModel(BaseModel):
 29    identity_ids_to_delete: Sequence[str] = Field(alias="IdentityIdsToDelete")
 30
 31
 32class ResponseMetadataModel(BaseModel):
 33    request_id: str = Field(alias="RequestId")
 34    host_id: str = Field(alias="HostId")
 35    http_status_code: int = Field(alias="HTTPStatusCode")
 36    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 37    retry_attempts: int = Field(alias="RetryAttempts")
 38
 39
 40class UnprocessedIdentityIdModel(BaseModel):
 41    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
 42    error_code: Optional[Literal["AccessDenied", "InternalServerError"]] = Field(
 43        default=None, alias="ErrorCode"
 44    )
 45
 46
 47class DeleteIdentityPoolInputRequestModel(BaseModel):
 48    identity_pool_id: str = Field(alias="IdentityPoolId")
 49
 50
 51class DescribeIdentityInputRequestModel(BaseModel):
 52    identity_id: str = Field(alias="IdentityId")
 53
 54
 55class DescribeIdentityPoolInputRequestModel(BaseModel):
 56    identity_pool_id: str = Field(alias="IdentityPoolId")
 57
 58
 59class GetCredentialsForIdentityInputRequestModel(BaseModel):
 60    identity_id: str = Field(alias="IdentityId")
 61    logins: Optional[Mapping[str, str]] = Field(default=None, alias="Logins")
 62    custom_role_arn: Optional[str] = Field(default=None, alias="CustomRoleArn")
 63
 64
 65class GetIdInputRequestModel(BaseModel):
 66    identity_pool_id: str = Field(alias="IdentityPoolId")
 67    account_id: Optional[str] = Field(default=None, alias="AccountId")
 68    logins: Optional[Mapping[str, str]] = Field(default=None, alias="Logins")
 69
 70
 71class GetIdentityPoolRolesInputRequestModel(BaseModel):
 72    identity_pool_id: str = Field(alias="IdentityPoolId")
 73
 74
 75class GetOpenIdTokenForDeveloperIdentityInputRequestModel(BaseModel):
 76    identity_pool_id: str = Field(alias="IdentityPoolId")
 77    logins: Mapping[str, str] = Field(alias="Logins")
 78    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
 79    principal_tags: Optional[Mapping[str, str]] = Field(
 80        default=None, alias="PrincipalTags"
 81    )
 82    token_duration: Optional[int] = Field(default=None, alias="TokenDuration")
 83
 84
 85class GetOpenIdTokenInputRequestModel(BaseModel):
 86    identity_id: str = Field(alias="IdentityId")
 87    logins: Optional[Mapping[str, str]] = Field(default=None, alias="Logins")
 88
 89
 90class GetPrincipalTagAttributeMapInputRequestModel(BaseModel):
 91    identity_pool_id: str = Field(alias="IdentityPoolId")
 92    identity_provider_name: str = Field(alias="IdentityProviderName")
 93
 94
 95class IdentityDescriptionModel(BaseModel):
 96    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
 97    logins: Optional[List[str]] = Field(default=None, alias="Logins")
 98    creation_date: Optional[datetime] = Field(default=None, alias="CreationDate")
 99    last_modified_date: Optional[datetime] = Field(
100        default=None, alias="LastModifiedDate"
101    )
102
103
104class IdentityPoolShortDescriptionModel(BaseModel):
105    identity_pool_id: Optional[str] = Field(default=None, alias="IdentityPoolId")
106    identity_pool_name: Optional[str] = Field(default=None, alias="IdentityPoolName")
107
108
109class ListIdentitiesInputRequestModel(BaseModel):
110    identity_pool_id: str = Field(alias="IdentityPoolId")
111    max_results: int = Field(alias="MaxResults")
112    next_token: Optional[str] = Field(default=None, alias="NextToken")
113    hide_disabled: Optional[bool] = Field(default=None, alias="HideDisabled")
114
115
116class PaginatorConfigModel(BaseModel):
117    max_items: Optional[int] = Field(default=None, alias="MaxItems")
118    page_size: Optional[int] = Field(default=None, alias="PageSize")
119    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
120
121
122class ListIdentityPoolsInputRequestModel(BaseModel):
123    max_results: int = Field(alias="MaxResults")
124    next_token: Optional[str] = Field(default=None, alias="NextToken")
125
126
127class ListTagsForResourceInputRequestModel(BaseModel):
128    resource_arn: str = Field(alias="ResourceArn")
129
130
131class LookupDeveloperIdentityInputRequestModel(BaseModel):
132    identity_pool_id: str = Field(alias="IdentityPoolId")
133    identity_id: Optional[str] = Field(default=None, alias="IdentityId")
134    developer_user_identifier: Optional[str] = Field(
135        default=None, alias="DeveloperUserIdentifier"
136    )
137    max_results: Optional[int] = Field(default=None, alias="MaxResults")
138    next_token: Optional[str] = Field(default=None, alias="NextToken")
139
140
141class MappingRuleModel(BaseModel):
142    claim: str = Field(alias="Claim")
143    match_type: Literal["Contains", "Equals", "NotEqual", "StartsWith"] = Field(
144        alias="MatchType"
145    )
146    value: str = Field(alias="Value")
147    role_arn: str = Field(alias="RoleARN")
148
149
150class MergeDeveloperIdentitiesInputRequestModel(BaseModel):
151    source_user_identifier: str = Field(alias="SourceUserIdentifier")
152    destination_user_identifier: str = Field(alias="DestinationUserIdentifier")
153    developer_provider_name: str = Field(alias="DeveloperProviderName")
154    identity_pool_id: str = Field(alias="IdentityPoolId")
155
156
157class SetPrincipalTagAttributeMapInputRequestModel(BaseModel):
158    identity_pool_id: str = Field(alias="IdentityPoolId")
159    identity_provider_name: str = Field(alias="IdentityProviderName")
160    use_defaults: Optional[bool] = Field(default=None, alias="UseDefaults")
161    principal_tags: Optional[Mapping[str, str]] = Field(
162        default=None, alias="PrincipalTags"
163    )
164
165
166class TagResourceInputRequestModel(BaseModel):
167    resource_arn: str = Field(alias="ResourceArn")
168    tags: Mapping[str, str] = Field(alias="Tags")
169
170
171class UnlinkDeveloperIdentityInputRequestModel(BaseModel):
172    identity_id: str = Field(alias="IdentityId")
173    identity_pool_id: str = Field(alias="IdentityPoolId")
174    developer_provider_name: str = Field(alias="DeveloperProviderName")
175    developer_user_identifier: str = Field(alias="DeveloperUserIdentifier")
176
177
178class UnlinkIdentityInputRequestModel(BaseModel):
179    identity_id: str = Field(alias="IdentityId")
180    logins: Mapping[str, str] = Field(alias="Logins")
181    logins_to_remove: Sequence[str] = Field(alias="LoginsToRemove")
182
183
184class UntagResourceInputRequestModel(BaseModel):
185    resource_arn: str = Field(alias="ResourceArn")
186    tag_keys: Sequence[str] = Field(alias="TagKeys")
187
188
189class CreateIdentityPoolInputRequestModel(BaseModel):
190    identity_pool_name: str = Field(alias="IdentityPoolName")
191    allow_unauthenticated_identities: bool = Field(
192        alias="AllowUnauthenticatedIdentities"
193    )
194    allow_classic_flow: Optional[bool] = Field(default=None, alias="AllowClassicFlow")
195    supported_login_providers: Optional[Mapping[str, str]] = Field(
196        default=None, alias="SupportedLoginProviders"
197    )
198    developer_provider_name: Optional[str] = Field(
199        default=None, alias="DeveloperProviderName"
200    )
201    open_id_connect_provider_arns: Optional[Sequence[str]] = Field(
202        default=None, alias="OpenIdConnectProviderARNs"
203    )
204    cognito_identity_providers: Optional[
205        Sequence[CognitoIdentityProviderModel]
206    ] = Field(default=None, alias="CognitoIdentityProviders")
207    saml_provider_arns: Optional[Sequence[str]] = Field(
208        default=None, alias="SamlProviderARNs"
209    )
210    identity_pool_tags: Optional[Mapping[str, str]] = Field(
211        default=None, alias="IdentityPoolTags"
212    )
213
214
215class IdentityPoolRequestModel(BaseModel):
216    identity_pool_id: str = Field(alias="IdentityPoolId")
217    identity_pool_name: str = Field(alias="IdentityPoolName")
218    allow_unauthenticated_identities: bool = Field(
219        alias="AllowUnauthenticatedIdentities"
220    )
221    allow_classic_flow: Optional[bool] = Field(default=None, alias="AllowClassicFlow")
222    supported_login_providers: Optional[Mapping[str, str]] = Field(
223        default=None, alias="SupportedLoginProviders"
224    )
225    developer_provider_name: Optional[str] = Field(
226        default=None, alias="DeveloperProviderName"
227    )
228    open_id_connect_provider_arns: Optional[Sequence[str]] = Field(
229        default=None, alias="OpenIdConnectProviderARNs"
230    )
231    cognito_identity_providers: Optional[
232        Sequence[CognitoIdentityProviderModel]
233    ] = Field(default=None, alias="CognitoIdentityProviders")
234    saml_provider_arns: Optional[Sequence[str]] = Field(
235        default=None, alias="SamlProviderARNs"
236    )
237    identity_pool_tags: Optional[Mapping[str, str]] = Field(
238        default=None, alias="IdentityPoolTags"
239    )
240
241
242class EmptyResponseMetadataModel(BaseModel):
243    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
244
245
246class GetCredentialsForIdentityResponseModel(BaseModel):
247    identity_id: str = Field(alias="IdentityId")
248    credentials: CredentialsModel = Field(alias="Credentials")
249    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
250
251
252class GetIdResponseModel(BaseModel):
253    identity_id: str = Field(alias="IdentityId")
254    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
255
256
257class GetOpenIdTokenForDeveloperIdentityResponseModel(BaseModel):
258    identity_id: str = Field(alias="IdentityId")
259    token: str = Field(alias="Token")
260    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
261
262
263class GetOpenIdTokenResponseModel(BaseModel):
264    identity_id: str = Field(alias="IdentityId")
265    token: str = Field(alias="Token")
266    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
267
268
269class GetPrincipalTagAttributeMapResponseModel(BaseModel):
270    identity_pool_id: str = Field(alias="IdentityPoolId")
271    identity_provider_name: str = Field(alias="IdentityProviderName")
272    use_defaults: bool = Field(alias="UseDefaults")
273    principal_tags: Dict[str, str] = Field(alias="PrincipalTags")
274    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
275
276
277class IdentityDescriptionResponseMetadataModel(BaseModel):
278    identity_id: str = Field(alias="IdentityId")
279    logins: List[str] = Field(alias="Logins")
280    creation_date: datetime = Field(alias="CreationDate")
281    last_modified_date: datetime = Field(alias="LastModifiedDate")
282    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
283
284
285class IdentityPoolModel(BaseModel):
286    identity_pool_id: str = Field(alias="IdentityPoolId")
287    identity_pool_name: str = Field(alias="IdentityPoolName")
288    allow_unauthenticated_identities: bool = Field(
289        alias="AllowUnauthenticatedIdentities"
290    )
291    allow_classic_flow: bool = Field(alias="AllowClassicFlow")
292    supported_login_providers: Dict[str, str] = Field(alias="SupportedLoginProviders")
293    developer_provider_name: str = Field(alias="DeveloperProviderName")
294    open_id_connect_provider_arns: List[str] = Field(alias="OpenIdConnectProviderARNs")
295    cognito_identity_providers: List[CognitoIdentityProviderModel] = Field(
296        alias="CognitoIdentityProviders"
297    )
298    saml_provider_arns: List[str] = Field(alias="SamlProviderARNs")
299    identity_pool_tags: Dict[str, str] = Field(alias="IdentityPoolTags")
300    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
301
302
303class ListTagsForResourceResponseModel(BaseModel):
304    tags: Dict[str, str] = Field(alias="Tags")
305    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
306
307
308class LookupDeveloperIdentityResponseModel(BaseModel):
309    identity_id: str = Field(alias="IdentityId")
310    developer_user_identifier_list: List[str] = Field(
311        alias="DeveloperUserIdentifierList"
312    )
313    next_token: str = Field(alias="NextToken")
314    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
315
316
317class MergeDeveloperIdentitiesResponseModel(BaseModel):
318    identity_id: str = Field(alias="IdentityId")
319    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
320
321
322class SetPrincipalTagAttributeMapResponseModel(BaseModel):
323    identity_pool_id: str = Field(alias="IdentityPoolId")
324    identity_provider_name: str = Field(alias="IdentityProviderName")
325    use_defaults: bool = Field(alias="UseDefaults")
326    principal_tags: Dict[str, str] = Field(alias="PrincipalTags")
327    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
328
329
330class DeleteIdentitiesResponseModel(BaseModel):
331    unprocessed_identity_ids: List[UnprocessedIdentityIdModel] = Field(
332        alias="UnprocessedIdentityIds"
333    )
334    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
335
336
337class ListIdentitiesResponseModel(BaseModel):
338    identity_pool_id: str = Field(alias="IdentityPoolId")
339    identities: List[IdentityDescriptionModel] = Field(alias="Identities")
340    next_token: str = Field(alias="NextToken")
341    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
342
343
344class ListIdentityPoolsResponseModel(BaseModel):
345    identity_pools: List[IdentityPoolShortDescriptionModel] = Field(
346        alias="IdentityPools"
347    )
348    next_token: str = Field(alias="NextToken")
349    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
350
351
352class ListIdentityPoolsInputListIdentityPoolsPaginateModel(BaseModel):
353    pagination_config: Optional[PaginatorConfigModel] = Field(
354        default=None, alias="PaginationConfig"
355    )
356
357
358class RulesConfigurationTypeModel(BaseModel):
359    rules: List[MappingRuleModel] = Field(alias="Rules")
360
361
362class RoleMappingModel(BaseModel):
363    type: Literal["Rules", "Token"] = Field(alias="Type")
364    ambiguous_role_resolution: Optional[Literal["AuthenticatedRole", "Deny"]] = Field(
365        default=None, alias="AmbiguousRoleResolution"
366    )
367    rules_configuration: Optional[RulesConfigurationTypeModel] = Field(
368        default=None, alias="RulesConfiguration"
369    )
370
371
372class GetIdentityPoolRolesResponseModel(BaseModel):
373    identity_pool_id: str = Field(alias="IdentityPoolId")
374    roles: Dict[str, str] = Field(alias="Roles")
375    role_mappings: Dict[str, RoleMappingModel] = Field(alias="RoleMappings")
376    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
377
378
379class SetIdentityPoolRolesInputRequestModel(BaseModel):
380    identity_pool_id: str = Field(alias="IdentityPoolId")
381    roles: Mapping[str, str] = Field(alias="Roles")
382    role_mappings: Optional[Mapping[str, RoleMappingModel]] = Field(
383        default=None, alias="RoleMappings"
384    )