mypydantic.models.apigateway

   1# Model Generated: Thu Mar  2 21:56:16 2023
   2
   3from __future__ import annotations
   4
   5from datetime import datetime
   6from typing import (
   7    Any,
   8    Dict,
   9    IO,
  10    List,
  11    Literal,
  12    Mapping,
  13    Optional,
  14    Sequence,
  15    Type,
  16    Union,
  17)
  18
  19from botocore.response import StreamingBody
  20from pydantic import Field
  21
  22from mypydantic.models.base_model import BaseModel
  23
  24
  25class AccessLogSettingsModel(BaseModel):
  26    format: Optional[str] = Field(default=None, alias="format")
  27    destination_arn: Optional[str] = Field(default=None, alias="destinationArn")
  28
  29
  30class ResponseMetadataModel(BaseModel):
  31    request_id: str = Field(alias="RequestId")
  32    host_id: str = Field(alias="HostId")
  33    http_status_code: int = Field(alias="HTTPStatusCode")
  34    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
  35    retry_attempts: int = Field(alias="RetryAttempts")
  36
  37
  38class ThrottleSettingsModel(BaseModel):
  39    burst_limit: Optional[int] = Field(default=None, alias="burstLimit")
  40    rate_limit: Optional[float] = Field(default=None, alias="rateLimit")
  41
  42
  43class ApiKeyModel(BaseModel):
  44    id: Optional[str] = Field(default=None, alias="id")
  45    value: Optional[str] = Field(default=None, alias="value")
  46    name: Optional[str] = Field(default=None, alias="name")
  47    customer_id: Optional[str] = Field(default=None, alias="customerId")
  48    description: Optional[str] = Field(default=None, alias="description")
  49    enabled: Optional[bool] = Field(default=None, alias="enabled")
  50    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
  51    last_updated_date: Optional[datetime] = Field(default=None, alias="lastUpdatedDate")
  52    stage_keys: Optional[List[str]] = Field(default=None, alias="stageKeys")
  53    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
  54
  55
  56class AuthorizerModel(BaseModel):
  57    id: Optional[str] = Field(default=None, alias="id")
  58    name: Optional[str] = Field(default=None, alias="name")
  59    type: Optional[Literal["COGNITO_USER_POOLS", "REQUEST", "TOKEN"]] = Field(
  60        default=None, alias="type"
  61    )
  62    provider_arns: Optional[List[str]] = Field(default=None, alias="providerARNs")
  63    auth_type: Optional[str] = Field(default=None, alias="authType")
  64    authorizer_uri: Optional[str] = Field(default=None, alias="authorizerUri")
  65    authorizer_credentials: Optional[str] = Field(
  66        default=None, alias="authorizerCredentials"
  67    )
  68    identity_source: Optional[str] = Field(default=None, alias="identitySource")
  69    identity_validation_expression: Optional[str] = Field(
  70        default=None, alias="identityValidationExpression"
  71    )
  72    authorizer_result_ttl_in_seconds: Optional[int] = Field(
  73        default=None, alias="authorizerResultTtlInSeconds"
  74    )
  75
  76
  77class BasePathMappingModel(BaseModel):
  78    base_path: Optional[str] = Field(default=None, alias="basePath")
  79    rest_api_id: Optional[str] = Field(default=None, alias="restApiId")
  80    stage: Optional[str] = Field(default=None, alias="stage")
  81
  82
  83class CanarySettingsModel(BaseModel):
  84    percent_traffic: Optional[float] = Field(default=None, alias="percentTraffic")
  85    deployment_id: Optional[str] = Field(default=None, alias="deploymentId")
  86    stage_variable_overrides: Optional[Mapping[str, str]] = Field(
  87        default=None, alias="stageVariableOverrides"
  88    )
  89    use_stage_cache: Optional[bool] = Field(default=None, alias="useStageCache")
  90
  91
  92class ClientCertificateModel(BaseModel):
  93    client_certificate_id: Optional[str] = Field(
  94        default=None, alias="clientCertificateId"
  95    )
  96    description: Optional[str] = Field(default=None, alias="description")
  97    pem_encoded_certificate: Optional[str] = Field(
  98        default=None, alias="pemEncodedCertificate"
  99    )
 100    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
 101    expiration_date: Optional[datetime] = Field(default=None, alias="expirationDate")
 102    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
 103
 104
 105class StageKeyModel(BaseModel):
 106    rest_api_id: Optional[str] = Field(default=None, alias="restApiId")
 107    stage_name: Optional[str] = Field(default=None, alias="stageName")
 108
 109
 110class CreateAuthorizerRequestModel(BaseModel):
 111    rest_api_id: str = Field(alias="restApiId")
 112    name: str = Field(alias="name")
 113    type: Literal["COGNITO_USER_POOLS", "REQUEST", "TOKEN"] = Field(alias="type")
 114    provider_arns: Optional[Sequence[str]] = Field(default=None, alias="providerARNs")
 115    auth_type: Optional[str] = Field(default=None, alias="authType")
 116    authorizer_uri: Optional[str] = Field(default=None, alias="authorizerUri")
 117    authorizer_credentials: Optional[str] = Field(
 118        default=None, alias="authorizerCredentials"
 119    )
 120    identity_source: Optional[str] = Field(default=None, alias="identitySource")
 121    identity_validation_expression: Optional[str] = Field(
 122        default=None, alias="identityValidationExpression"
 123    )
 124    authorizer_result_ttl_in_seconds: Optional[int] = Field(
 125        default=None, alias="authorizerResultTtlInSeconds"
 126    )
 127
 128
 129class CreateBasePathMappingRequestModel(BaseModel):
 130    domain_name: str = Field(alias="domainName")
 131    rest_api_id: str = Field(alias="restApiId")
 132    base_path: Optional[str] = Field(default=None, alias="basePath")
 133    stage: Optional[str] = Field(default=None, alias="stage")
 134
 135
 136class DeploymentCanarySettingsModel(BaseModel):
 137    percent_traffic: Optional[float] = Field(default=None, alias="percentTraffic")
 138    stage_variable_overrides: Optional[Mapping[str, str]] = Field(
 139        default=None, alias="stageVariableOverrides"
 140    )
 141    use_stage_cache: Optional[bool] = Field(default=None, alias="useStageCache")
 142
 143
 144class DocumentationPartLocationModel(BaseModel):
 145    type: Literal[
 146        "API",
 147        "AUTHORIZER",
 148        "METHOD",
 149        "MODEL",
 150        "PATH_PARAMETER",
 151        "QUERY_PARAMETER",
 152        "REQUEST_BODY",
 153        "REQUEST_HEADER",
 154        "RESOURCE",
 155        "RESPONSE",
 156        "RESPONSE_BODY",
 157        "RESPONSE_HEADER",
 158    ] = Field(alias="type")
 159    path: Optional[str] = Field(default=None, alias="path")
 160    method: Optional[str] = Field(default=None, alias="method")
 161    status_code: Optional[str] = Field(default=None, alias="statusCode")
 162    name: Optional[str] = Field(default=None, alias="name")
 163
 164
 165class CreateDocumentationVersionRequestModel(BaseModel):
 166    rest_api_id: str = Field(alias="restApiId")
 167    documentation_version: str = Field(alias="documentationVersion")
 168    stage_name: Optional[str] = Field(default=None, alias="stageName")
 169    description: Optional[str] = Field(default=None, alias="description")
 170
 171
 172class EndpointConfigurationModel(BaseModel):
 173    types: Optional[Sequence[Literal["EDGE", "PRIVATE", "REGIONAL"]]] = Field(
 174        default=None, alias="types"
 175    )
 176    vpc_endpoint_ids: Optional[Sequence[str]] = Field(
 177        default=None, alias="vpcEndpointIds"
 178    )
 179
 180
 181class MutualTlsAuthenticationInputModel(BaseModel):
 182    truststore_uri: Optional[str] = Field(default=None, alias="truststoreUri")
 183    truststore_version: Optional[str] = Field(default=None, alias="truststoreVersion")
 184
 185
 186class CreateModelRequestModel(BaseModel):
 187    rest_api_id: str = Field(alias="restApiId")
 188    name: str = Field(alias="name")
 189    content_type: str = Field(alias="contentType")
 190    description: Optional[str] = Field(default=None, alias="description")
 191    schema_: Optional[str] = Field(default=None, alias="schema")
 192
 193
 194class CreateRequestValidatorRequestModel(BaseModel):
 195    rest_api_id: str = Field(alias="restApiId")
 196    name: Optional[str] = Field(default=None, alias="name")
 197    validate_request_body: Optional[bool] = Field(
 198        default=None, alias="validateRequestBody"
 199    )
 200    validate_request_parameters: Optional[bool] = Field(
 201        default=None, alias="validateRequestParameters"
 202    )
 203
 204
 205class CreateResourceRequestModel(BaseModel):
 206    rest_api_id: str = Field(alias="restApiId")
 207    parent_id: str = Field(alias="parentId")
 208    path_part: str = Field(alias="pathPart")
 209
 210
 211class CreateUsagePlanKeyRequestModel(BaseModel):
 212    usage_plan_id: str = Field(alias="usagePlanId")
 213    key_id: str = Field(alias="keyId")
 214    key_type: str = Field(alias="keyType")
 215
 216
 217class QuotaSettingsModel(BaseModel):
 218    limit: Optional[int] = Field(default=None, alias="limit")
 219    offset: Optional[int] = Field(default=None, alias="offset")
 220    period: Optional[Literal["DAY", "MONTH", "WEEK"]] = Field(
 221        default=None, alias="period"
 222    )
 223
 224
 225class CreateVpcLinkRequestModel(BaseModel):
 226    name: str = Field(alias="name")
 227    target_arns: Sequence[str] = Field(alias="targetArns")
 228    description: Optional[str] = Field(default=None, alias="description")
 229    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
 230
 231
 232class DeleteApiKeyRequestModel(BaseModel):
 233    api_key: str = Field(alias="apiKey")
 234
 235
 236class DeleteAuthorizerRequestModel(BaseModel):
 237    rest_api_id: str = Field(alias="restApiId")
 238    authorizer_id: str = Field(alias="authorizerId")
 239
 240
 241class DeleteBasePathMappingRequestModel(BaseModel):
 242    domain_name: str = Field(alias="domainName")
 243    base_path: str = Field(alias="basePath")
 244
 245
 246class DeleteClientCertificateRequestModel(BaseModel):
 247    client_certificate_id: str = Field(alias="clientCertificateId")
 248
 249
 250class DeleteDeploymentRequestModel(BaseModel):
 251    rest_api_id: str = Field(alias="restApiId")
 252    deployment_id: str = Field(alias="deploymentId")
 253
 254
 255class DeleteDocumentationPartRequestModel(BaseModel):
 256    rest_api_id: str = Field(alias="restApiId")
 257    documentation_part_id: str = Field(alias="documentationPartId")
 258
 259
 260class DeleteDocumentationVersionRequestModel(BaseModel):
 261    rest_api_id: str = Field(alias="restApiId")
 262    documentation_version: str = Field(alias="documentationVersion")
 263
 264
 265class DeleteDomainNameRequestModel(BaseModel):
 266    domain_name: str = Field(alias="domainName")
 267
 268
 269class DeleteGatewayResponseRequestModel(BaseModel):
 270    rest_api_id: str = Field(alias="restApiId")
 271    response_type: Literal[
 272        "ACCESS_DENIED",
 273        "API_CONFIGURATION_ERROR",
 274        "AUTHORIZER_CONFIGURATION_ERROR",
 275        "AUTHORIZER_FAILURE",
 276        "BAD_REQUEST_BODY",
 277        "BAD_REQUEST_PARAMETERS",
 278        "DEFAULT_4XX",
 279        "DEFAULT_5XX",
 280        "EXPIRED_TOKEN",
 281        "INTEGRATION_FAILURE",
 282        "INTEGRATION_TIMEOUT",
 283        "INVALID_API_KEY",
 284        "INVALID_SIGNATURE",
 285        "MISSING_AUTHENTICATION_TOKEN",
 286        "QUOTA_EXCEEDED",
 287        "REQUEST_TOO_LARGE",
 288        "RESOURCE_NOT_FOUND",
 289        "THROTTLED",
 290        "UNAUTHORIZED",
 291        "UNSUPPORTED_MEDIA_TYPE",
 292        "WAF_FILTERED",
 293    ] = Field(alias="responseType")
 294
 295
 296class DeleteIntegrationRequestModel(BaseModel):
 297    rest_api_id: str = Field(alias="restApiId")
 298    resource_id: str = Field(alias="resourceId")
 299    http_method: str = Field(alias="httpMethod")
 300
 301
 302class DeleteIntegrationResponseRequestModel(BaseModel):
 303    rest_api_id: str = Field(alias="restApiId")
 304    resource_id: str = Field(alias="resourceId")
 305    http_method: str = Field(alias="httpMethod")
 306    status_code: str = Field(alias="statusCode")
 307
 308
 309class DeleteMethodRequestModel(BaseModel):
 310    rest_api_id: str = Field(alias="restApiId")
 311    resource_id: str = Field(alias="resourceId")
 312    http_method: str = Field(alias="httpMethod")
 313
 314
 315class DeleteMethodResponseRequestModel(BaseModel):
 316    rest_api_id: str = Field(alias="restApiId")
 317    resource_id: str = Field(alias="resourceId")
 318    http_method: str = Field(alias="httpMethod")
 319    status_code: str = Field(alias="statusCode")
 320
 321
 322class DeleteModelRequestModel(BaseModel):
 323    rest_api_id: str = Field(alias="restApiId")
 324    model_name: str = Field(alias="modelName")
 325
 326
 327class DeleteRequestValidatorRequestModel(BaseModel):
 328    rest_api_id: str = Field(alias="restApiId")
 329    request_validator_id: str = Field(alias="requestValidatorId")
 330
 331
 332class DeleteResourceRequestModel(BaseModel):
 333    rest_api_id: str = Field(alias="restApiId")
 334    resource_id: str = Field(alias="resourceId")
 335
 336
 337class DeleteRestApiRequestModel(BaseModel):
 338    rest_api_id: str = Field(alias="restApiId")
 339
 340
 341class DeleteStageRequestModel(BaseModel):
 342    rest_api_id: str = Field(alias="restApiId")
 343    stage_name: str = Field(alias="stageName")
 344
 345
 346class DeleteUsagePlanKeyRequestModel(BaseModel):
 347    usage_plan_id: str = Field(alias="usagePlanId")
 348    key_id: str = Field(alias="keyId")
 349
 350
 351class DeleteUsagePlanRequestModel(BaseModel):
 352    usage_plan_id: str = Field(alias="usagePlanId")
 353
 354
 355class DeleteVpcLinkRequestModel(BaseModel):
 356    vpc_link_id: str = Field(alias="vpcLinkId")
 357
 358
 359class MethodSnapshotModel(BaseModel):
 360    authorization_type: Optional[str] = Field(default=None, alias="authorizationType")
 361    api_key_required: Optional[bool] = Field(default=None, alias="apiKeyRequired")
 362
 363
 364class DocumentationVersionModel(BaseModel):
 365    version: Optional[str] = Field(default=None, alias="version")
 366    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
 367    description: Optional[str] = Field(default=None, alias="description")
 368
 369
 370class MutualTlsAuthenticationModel(BaseModel):
 371    truststore_uri: Optional[str] = Field(default=None, alias="truststoreUri")
 372    truststore_version: Optional[str] = Field(default=None, alias="truststoreVersion")
 373    truststore_warnings: Optional[List[str]] = Field(
 374        default=None, alias="truststoreWarnings"
 375    )
 376
 377
 378class FlushStageAuthorizersCacheRequestModel(BaseModel):
 379    rest_api_id: str = Field(alias="restApiId")
 380    stage_name: str = Field(alias="stageName")
 381
 382
 383class FlushStageCacheRequestModel(BaseModel):
 384    rest_api_id: str = Field(alias="restApiId")
 385    stage_name: str = Field(alias="stageName")
 386
 387
 388class GatewayResponseModel(BaseModel):
 389    response_type: Optional[
 390        Literal[
 391            "ACCESS_DENIED",
 392            "API_CONFIGURATION_ERROR",
 393            "AUTHORIZER_CONFIGURATION_ERROR",
 394            "AUTHORIZER_FAILURE",
 395            "BAD_REQUEST_BODY",
 396            "BAD_REQUEST_PARAMETERS",
 397            "DEFAULT_4XX",
 398            "DEFAULT_5XX",
 399            "EXPIRED_TOKEN",
 400            "INTEGRATION_FAILURE",
 401            "INTEGRATION_TIMEOUT",
 402            "INVALID_API_KEY",
 403            "INVALID_SIGNATURE",
 404            "MISSING_AUTHENTICATION_TOKEN",
 405            "QUOTA_EXCEEDED",
 406            "REQUEST_TOO_LARGE",
 407            "RESOURCE_NOT_FOUND",
 408            "THROTTLED",
 409            "UNAUTHORIZED",
 410            "UNSUPPORTED_MEDIA_TYPE",
 411            "WAF_FILTERED",
 412        ]
 413    ] = Field(default=None, alias="responseType")
 414    status_code: Optional[str] = Field(default=None, alias="statusCode")
 415    response_parameters: Optional[Dict[str, str]] = Field(
 416        default=None, alias="responseParameters"
 417    )
 418    response_templates: Optional[Dict[str, str]] = Field(
 419        default=None, alias="responseTemplates"
 420    )
 421    default_response: Optional[bool] = Field(default=None, alias="defaultResponse")
 422
 423
 424class GenerateClientCertificateRequestModel(BaseModel):
 425    description: Optional[str] = Field(default=None, alias="description")
 426    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
 427
 428
 429class GetApiKeyRequestModel(BaseModel):
 430    api_key: str = Field(alias="apiKey")
 431    include_value: Optional[bool] = Field(default=None, alias="includeValue")
 432
 433
 434class PaginatorConfigModel(BaseModel):
 435    max_items: Optional[int] = Field(default=None, alias="MaxItems")
 436    page_size: Optional[int] = Field(default=None, alias="PageSize")
 437    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
 438
 439
 440class GetApiKeysRequestModel(BaseModel):
 441    position: Optional[str] = Field(default=None, alias="position")
 442    limit: Optional[int] = Field(default=None, alias="limit")
 443    name_query: Optional[str] = Field(default=None, alias="nameQuery")
 444    customer_id: Optional[str] = Field(default=None, alias="customerId")
 445    include_values: Optional[bool] = Field(default=None, alias="includeValues")
 446
 447
 448class GetAuthorizerRequestModel(BaseModel):
 449    rest_api_id: str = Field(alias="restApiId")
 450    authorizer_id: str = Field(alias="authorizerId")
 451
 452
 453class GetAuthorizersRequestModel(BaseModel):
 454    rest_api_id: str = Field(alias="restApiId")
 455    position: Optional[str] = Field(default=None, alias="position")
 456    limit: Optional[int] = Field(default=None, alias="limit")
 457
 458
 459class GetBasePathMappingRequestModel(BaseModel):
 460    domain_name: str = Field(alias="domainName")
 461    base_path: str = Field(alias="basePath")
 462
 463
 464class GetBasePathMappingsRequestModel(BaseModel):
 465    domain_name: str = Field(alias="domainName")
 466    position: Optional[str] = Field(default=None, alias="position")
 467    limit: Optional[int] = Field(default=None, alias="limit")
 468
 469
 470class GetClientCertificateRequestModel(BaseModel):
 471    client_certificate_id: str = Field(alias="clientCertificateId")
 472
 473
 474class GetClientCertificatesRequestModel(BaseModel):
 475    position: Optional[str] = Field(default=None, alias="position")
 476    limit: Optional[int] = Field(default=None, alias="limit")
 477
 478
 479class GetDeploymentRequestModel(BaseModel):
 480    rest_api_id: str = Field(alias="restApiId")
 481    deployment_id: str = Field(alias="deploymentId")
 482    embed: Optional[Sequence[str]] = Field(default=None, alias="embed")
 483
 484
 485class GetDeploymentsRequestModel(BaseModel):
 486    rest_api_id: str = Field(alias="restApiId")
 487    position: Optional[str] = Field(default=None, alias="position")
 488    limit: Optional[int] = Field(default=None, alias="limit")
 489
 490
 491class GetDocumentationPartRequestModel(BaseModel):
 492    rest_api_id: str = Field(alias="restApiId")
 493    documentation_part_id: str = Field(alias="documentationPartId")
 494
 495
 496class GetDocumentationPartsRequestModel(BaseModel):
 497    rest_api_id: str = Field(alias="restApiId")
 498    type: Optional[
 499        Literal[
 500            "API",
 501            "AUTHORIZER",
 502            "METHOD",
 503            "MODEL",
 504            "PATH_PARAMETER",
 505            "QUERY_PARAMETER",
 506            "REQUEST_BODY",
 507            "REQUEST_HEADER",
 508            "RESOURCE",
 509            "RESPONSE",
 510            "RESPONSE_BODY",
 511            "RESPONSE_HEADER",
 512        ]
 513    ] = Field(default=None, alias="type")
 514    name_query: Optional[str] = Field(default=None, alias="nameQuery")
 515    path: Optional[str] = Field(default=None, alias="path")
 516    position: Optional[str] = Field(default=None, alias="position")
 517    limit: Optional[int] = Field(default=None, alias="limit")
 518    location_status: Optional[Literal["DOCUMENTED", "UNDOCUMENTED"]] = Field(
 519        default=None, alias="locationStatus"
 520    )
 521
 522
 523class GetDocumentationVersionRequestModel(BaseModel):
 524    rest_api_id: str = Field(alias="restApiId")
 525    documentation_version: str = Field(alias="documentationVersion")
 526
 527
 528class GetDocumentationVersionsRequestModel(BaseModel):
 529    rest_api_id: str = Field(alias="restApiId")
 530    position: Optional[str] = Field(default=None, alias="position")
 531    limit: Optional[int] = Field(default=None, alias="limit")
 532
 533
 534class GetDomainNameRequestModel(BaseModel):
 535    domain_name: str = Field(alias="domainName")
 536
 537
 538class GetDomainNamesRequestModel(BaseModel):
 539    position: Optional[str] = Field(default=None, alias="position")
 540    limit: Optional[int] = Field(default=None, alias="limit")
 541
 542
 543class GetExportRequestModel(BaseModel):
 544    rest_api_id: str = Field(alias="restApiId")
 545    stage_name: str = Field(alias="stageName")
 546    export_type: str = Field(alias="exportType")
 547    parameters: Optional[Mapping[str, str]] = Field(default=None, alias="parameters")
 548    accepts: Optional[str] = Field(default=None, alias="accepts")
 549
 550
 551class GetGatewayResponseRequestModel(BaseModel):
 552    rest_api_id: str = Field(alias="restApiId")
 553    response_type: Literal[
 554        "ACCESS_DENIED",
 555        "API_CONFIGURATION_ERROR",
 556        "AUTHORIZER_CONFIGURATION_ERROR",
 557        "AUTHORIZER_FAILURE",
 558        "BAD_REQUEST_BODY",
 559        "BAD_REQUEST_PARAMETERS",
 560        "DEFAULT_4XX",
 561        "DEFAULT_5XX",
 562        "EXPIRED_TOKEN",
 563        "INTEGRATION_FAILURE",
 564        "INTEGRATION_TIMEOUT",
 565        "INVALID_API_KEY",
 566        "INVALID_SIGNATURE",
 567        "MISSING_AUTHENTICATION_TOKEN",
 568        "QUOTA_EXCEEDED",
 569        "REQUEST_TOO_LARGE",
 570        "RESOURCE_NOT_FOUND",
 571        "THROTTLED",
 572        "UNAUTHORIZED",
 573        "UNSUPPORTED_MEDIA_TYPE",
 574        "WAF_FILTERED",
 575    ] = Field(alias="responseType")
 576
 577
 578class GetGatewayResponsesRequestModel(BaseModel):
 579    rest_api_id: str = Field(alias="restApiId")
 580    position: Optional[str] = Field(default=None, alias="position")
 581    limit: Optional[int] = Field(default=None, alias="limit")
 582
 583
 584class GetIntegrationRequestModel(BaseModel):
 585    rest_api_id: str = Field(alias="restApiId")
 586    resource_id: str = Field(alias="resourceId")
 587    http_method: str = Field(alias="httpMethod")
 588
 589
 590class GetIntegrationResponseRequestModel(BaseModel):
 591    rest_api_id: str = Field(alias="restApiId")
 592    resource_id: str = Field(alias="resourceId")
 593    http_method: str = Field(alias="httpMethod")
 594    status_code: str = Field(alias="statusCode")
 595
 596
 597class GetMethodRequestModel(BaseModel):
 598    rest_api_id: str = Field(alias="restApiId")
 599    resource_id: str = Field(alias="resourceId")
 600    http_method: str = Field(alias="httpMethod")
 601
 602
 603class GetMethodResponseRequestModel(BaseModel):
 604    rest_api_id: str = Field(alias="restApiId")
 605    resource_id: str = Field(alias="resourceId")
 606    http_method: str = Field(alias="httpMethod")
 607    status_code: str = Field(alias="statusCode")
 608
 609
 610class GetModelRequestModel(BaseModel):
 611    rest_api_id: str = Field(alias="restApiId")
 612    model_name: str = Field(alias="modelName")
 613    flatten: Optional[bool] = Field(default=None, alias="flatten")
 614
 615
 616class GetModelTemplateRequestModel(BaseModel):
 617    rest_api_id: str = Field(alias="restApiId")
 618    model_name: str = Field(alias="modelName")
 619
 620
 621class GetModelsRequestModel(BaseModel):
 622    rest_api_id: str = Field(alias="restApiId")
 623    position: Optional[str] = Field(default=None, alias="position")
 624    limit: Optional[int] = Field(default=None, alias="limit")
 625
 626
 627class GetRequestValidatorRequestModel(BaseModel):
 628    rest_api_id: str = Field(alias="restApiId")
 629    request_validator_id: str = Field(alias="requestValidatorId")
 630
 631
 632class GetRequestValidatorsRequestModel(BaseModel):
 633    rest_api_id: str = Field(alias="restApiId")
 634    position: Optional[str] = Field(default=None, alias="position")
 635    limit: Optional[int] = Field(default=None, alias="limit")
 636
 637
 638class GetResourceRequestModel(BaseModel):
 639    rest_api_id: str = Field(alias="restApiId")
 640    resource_id: str = Field(alias="resourceId")
 641    embed: Optional[Sequence[str]] = Field(default=None, alias="embed")
 642
 643
 644class GetResourcesRequestModel(BaseModel):
 645    rest_api_id: str = Field(alias="restApiId")
 646    position: Optional[str] = Field(default=None, alias="position")
 647    limit: Optional[int] = Field(default=None, alias="limit")
 648    embed: Optional[Sequence[str]] = Field(default=None, alias="embed")
 649
 650
 651class GetRestApiRequestModel(BaseModel):
 652    rest_api_id: str = Field(alias="restApiId")
 653
 654
 655class GetRestApisRequestModel(BaseModel):
 656    position: Optional[str] = Field(default=None, alias="position")
 657    limit: Optional[int] = Field(default=None, alias="limit")
 658
 659
 660class GetSdkRequestModel(BaseModel):
 661    rest_api_id: str = Field(alias="restApiId")
 662    stage_name: str = Field(alias="stageName")
 663    sdk_type: str = Field(alias="sdkType")
 664    parameters: Optional[Mapping[str, str]] = Field(default=None, alias="parameters")
 665
 666
 667class GetSdkTypeRequestModel(BaseModel):
 668    id: str = Field(alias="id")
 669
 670
 671class GetSdkTypesRequestModel(BaseModel):
 672    position: Optional[str] = Field(default=None, alias="position")
 673    limit: Optional[int] = Field(default=None, alias="limit")
 674
 675
 676class GetStageRequestModel(BaseModel):
 677    rest_api_id: str = Field(alias="restApiId")
 678    stage_name: str = Field(alias="stageName")
 679
 680
 681class GetStagesRequestModel(BaseModel):
 682    rest_api_id: str = Field(alias="restApiId")
 683    deployment_id: Optional[str] = Field(default=None, alias="deploymentId")
 684
 685
 686class GetTagsRequestModel(BaseModel):
 687    resource_arn: str = Field(alias="resourceArn")
 688    position: Optional[str] = Field(default=None, alias="position")
 689    limit: Optional[int] = Field(default=None, alias="limit")
 690
 691
 692class GetUsagePlanKeyRequestModel(BaseModel):
 693    usage_plan_id: str = Field(alias="usagePlanId")
 694    key_id: str = Field(alias="keyId")
 695
 696
 697class GetUsagePlanKeysRequestModel(BaseModel):
 698    usage_plan_id: str = Field(alias="usagePlanId")
 699    position: Optional[str] = Field(default=None, alias="position")
 700    limit: Optional[int] = Field(default=None, alias="limit")
 701    name_query: Optional[str] = Field(default=None, alias="nameQuery")
 702
 703
 704class GetUsagePlanRequestModel(BaseModel):
 705    usage_plan_id: str = Field(alias="usagePlanId")
 706
 707
 708class GetUsagePlansRequestModel(BaseModel):
 709    position: Optional[str] = Field(default=None, alias="position")
 710    key_id: Optional[str] = Field(default=None, alias="keyId")
 711    limit: Optional[int] = Field(default=None, alias="limit")
 712
 713
 714class GetUsageRequestModel(BaseModel):
 715    usage_plan_id: str = Field(alias="usagePlanId")
 716    start_date: str = Field(alias="startDate")
 717    end_date: str = Field(alias="endDate")
 718    key_id: Optional[str] = Field(default=None, alias="keyId")
 719    position: Optional[str] = Field(default=None, alias="position")
 720    limit: Optional[int] = Field(default=None, alias="limit")
 721
 722
 723class GetVpcLinkRequestModel(BaseModel):
 724    vpc_link_id: str = Field(alias="vpcLinkId")
 725
 726
 727class GetVpcLinksRequestModel(BaseModel):
 728    position: Optional[str] = Field(default=None, alias="position")
 729    limit: Optional[int] = Field(default=None, alias="limit")
 730
 731
 732class ImportApiKeysRequestModel(BaseModel):
 733    body: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(alias="body")
 734    format: Literal["csv"] = Field(alias="format")
 735    fail_on_warnings: Optional[bool] = Field(default=None, alias="failOnWarnings")
 736
 737
 738class ImportDocumentationPartsRequestModel(BaseModel):
 739    rest_api_id: str = Field(alias="restApiId")
 740    body: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(alias="body")
 741    mode: Optional[Literal["merge", "overwrite"]] = Field(default=None, alias="mode")
 742    fail_on_warnings: Optional[bool] = Field(default=None, alias="failOnWarnings")
 743
 744
 745class ImportRestApiRequestModel(BaseModel):
 746    body: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(alias="body")
 747    fail_on_warnings: Optional[bool] = Field(default=None, alias="failOnWarnings")
 748    parameters: Optional[Mapping[str, str]] = Field(default=None, alias="parameters")
 749
 750
 751class IntegrationResponseModel(BaseModel):
 752    status_code: Optional[str] = Field(default=None, alias="statusCode")
 753    selection_pattern: Optional[str] = Field(default=None, alias="selectionPattern")
 754    response_parameters: Optional[Dict[str, str]] = Field(
 755        default=None, alias="responseParameters"
 756    )
 757    response_templates: Optional[Dict[str, str]] = Field(
 758        default=None, alias="responseTemplates"
 759    )
 760    content_handling: Optional[Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"]] = Field(
 761        default=None, alias="contentHandling"
 762    )
 763
 764
 765class TlsConfigModel(BaseModel):
 766    insecure_skip_verification: Optional[bool] = Field(
 767        default=None, alias="insecureSkipVerification"
 768    )
 769
 770
 771class MethodResponseModel(BaseModel):
 772    status_code: Optional[str] = Field(default=None, alias="statusCode")
 773    response_parameters: Optional[Dict[str, bool]] = Field(
 774        default=None, alias="responseParameters"
 775    )
 776    response_models: Optional[Dict[str, str]] = Field(
 777        default=None, alias="responseModels"
 778    )
 779
 780
 781class MethodSettingModel(BaseModel):
 782    metrics_enabled: Optional[bool] = Field(default=None, alias="metricsEnabled")
 783    logging_level: Optional[str] = Field(default=None, alias="loggingLevel")
 784    data_trace_enabled: Optional[bool] = Field(default=None, alias="dataTraceEnabled")
 785    throttling_burst_limit: Optional[int] = Field(
 786        default=None, alias="throttlingBurstLimit"
 787    )
 788    throttling_rate_limit: Optional[float] = Field(
 789        default=None, alias="throttlingRateLimit"
 790    )
 791    caching_enabled: Optional[bool] = Field(default=None, alias="cachingEnabled")
 792    cache_ttl_in_seconds: Optional[int] = Field(default=None, alias="cacheTtlInSeconds")
 793    cache_data_encrypted: Optional[bool] = Field(
 794        default=None, alias="cacheDataEncrypted"
 795    )
 796    require_authorization_for_cache_control: Optional[bool] = Field(
 797        default=None, alias="requireAuthorizationForCacheControl"
 798    )
 799    unauthorized_cache_control_header_strategy: Optional[
 800        Literal[
 801            "FAIL_WITH_403",
 802            "SUCCEED_WITHOUT_RESPONSE_HEADER",
 803            "SUCCEED_WITH_RESPONSE_HEADER",
 804        ]
 805    ] = Field(default=None, alias="unauthorizedCacheControlHeaderStrategy")
 806
 807
 808class ModelModel(BaseModel):
 809    id: Optional[str] = Field(default=None, alias="id")
 810    name: Optional[str] = Field(default=None, alias="name")
 811    description: Optional[str] = Field(default=None, alias="description")
 812    schema_: Optional[str] = Field(default=None, alias="schema")
 813    content_type: Optional[str] = Field(default=None, alias="contentType")
 814
 815
 816class PatchOperationModel(BaseModel):
 817    op: Optional[Literal["add", "copy", "move", "remove", "replace", "test"]] = Field(
 818        default=None, alias="op"
 819    )
 820    path: Optional[str] = Field(default=None, alias="path")
 821    value: Optional[str] = Field(default=None, alias="value")
 822    from_: Optional[str] = Field(default=None, alias="from")
 823
 824
 825class PutGatewayResponseRequestModel(BaseModel):
 826    rest_api_id: str = Field(alias="restApiId")
 827    response_type: Literal[
 828        "ACCESS_DENIED",
 829        "API_CONFIGURATION_ERROR",
 830        "AUTHORIZER_CONFIGURATION_ERROR",
 831        "AUTHORIZER_FAILURE",
 832        "BAD_REQUEST_BODY",
 833        "BAD_REQUEST_PARAMETERS",
 834        "DEFAULT_4XX",
 835        "DEFAULT_5XX",
 836        "EXPIRED_TOKEN",
 837        "INTEGRATION_FAILURE",
 838        "INTEGRATION_TIMEOUT",
 839        "INVALID_API_KEY",
 840        "INVALID_SIGNATURE",
 841        "MISSING_AUTHENTICATION_TOKEN",
 842        "QUOTA_EXCEEDED",
 843        "REQUEST_TOO_LARGE",
 844        "RESOURCE_NOT_FOUND",
 845        "THROTTLED",
 846        "UNAUTHORIZED",
 847        "UNSUPPORTED_MEDIA_TYPE",
 848        "WAF_FILTERED",
 849    ] = Field(alias="responseType")
 850    status_code: Optional[str] = Field(default=None, alias="statusCode")
 851    response_parameters: Optional[Mapping[str, str]] = Field(
 852        default=None, alias="responseParameters"
 853    )
 854    response_templates: Optional[Mapping[str, str]] = Field(
 855        default=None, alias="responseTemplates"
 856    )
 857
 858
 859class PutIntegrationResponseRequestModel(BaseModel):
 860    rest_api_id: str = Field(alias="restApiId")
 861    resource_id: str = Field(alias="resourceId")
 862    http_method: str = Field(alias="httpMethod")
 863    status_code: str = Field(alias="statusCode")
 864    selection_pattern: Optional[str] = Field(default=None, alias="selectionPattern")
 865    response_parameters: Optional[Mapping[str, str]] = Field(
 866        default=None, alias="responseParameters"
 867    )
 868    response_templates: Optional[Mapping[str, str]] = Field(
 869        default=None, alias="responseTemplates"
 870    )
 871    content_handling: Optional[Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"]] = Field(
 872        default=None, alias="contentHandling"
 873    )
 874
 875
 876class PutMethodRequestModel(BaseModel):
 877    rest_api_id: str = Field(alias="restApiId")
 878    resource_id: str = Field(alias="resourceId")
 879    http_method: str = Field(alias="httpMethod")
 880    authorization_type: str = Field(alias="authorizationType")
 881    authorizer_id: Optional[str] = Field(default=None, alias="authorizerId")
 882    api_key_required: Optional[bool] = Field(default=None, alias="apiKeyRequired")
 883    operation_name: Optional[str] = Field(default=None, alias="operationName")
 884    request_parameters: Optional[Mapping[str, bool]] = Field(
 885        default=None, alias="requestParameters"
 886    )
 887    request_models: Optional[Mapping[str, str]] = Field(
 888        default=None, alias="requestModels"
 889    )
 890    request_validator_id: Optional[str] = Field(
 891        default=None, alias="requestValidatorId"
 892    )
 893    authorization_scopes: Optional[Sequence[str]] = Field(
 894        default=None, alias="authorizationScopes"
 895    )
 896
 897
 898class PutMethodResponseRequestModel(BaseModel):
 899    rest_api_id: str = Field(alias="restApiId")
 900    resource_id: str = Field(alias="resourceId")
 901    http_method: str = Field(alias="httpMethod")
 902    status_code: str = Field(alias="statusCode")
 903    response_parameters: Optional[Mapping[str, bool]] = Field(
 904        default=None, alias="responseParameters"
 905    )
 906    response_models: Optional[Mapping[str, str]] = Field(
 907        default=None, alias="responseModels"
 908    )
 909
 910
 911class PutRestApiRequestModel(BaseModel):
 912    rest_api_id: str = Field(alias="restApiId")
 913    body: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(alias="body")
 914    mode: Optional[Literal["merge", "overwrite"]] = Field(default=None, alias="mode")
 915    fail_on_warnings: Optional[bool] = Field(default=None, alias="failOnWarnings")
 916    parameters: Optional[Mapping[str, str]] = Field(default=None, alias="parameters")
 917
 918
 919class RequestValidatorModel(BaseModel):
 920    id: Optional[str] = Field(default=None, alias="id")
 921    name: Optional[str] = Field(default=None, alias="name")
 922    validate_request_body: Optional[bool] = Field(
 923        default=None, alias="validateRequestBody"
 924    )
 925    validate_request_parameters: Optional[bool] = Field(
 926        default=None, alias="validateRequestParameters"
 927    )
 928
 929
 930class SdkConfigurationPropertyModel(BaseModel):
 931    name: Optional[str] = Field(default=None, alias="name")
 932    friendly_name: Optional[str] = Field(default=None, alias="friendlyName")
 933    description: Optional[str] = Field(default=None, alias="description")
 934    required: Optional[bool] = Field(default=None, alias="required")
 935    default_value: Optional[str] = Field(default=None, alias="defaultValue")
 936
 937
 938class TagResourceRequestModel(BaseModel):
 939    resource_arn: str = Field(alias="resourceArn")
 940    tags: Mapping[str, str] = Field(alias="tags")
 941
 942
 943class TestInvokeAuthorizerRequestModel(BaseModel):
 944    rest_api_id: str = Field(alias="restApiId")
 945    authorizer_id: str = Field(alias="authorizerId")
 946    headers: Optional[Mapping[str, str]] = Field(default=None, alias="headers")
 947    multi_value_headers: Optional[Mapping[str, Sequence[str]]] = Field(
 948        default=None, alias="multiValueHeaders"
 949    )
 950    path_with_query_string: Optional[str] = Field(
 951        default=None, alias="pathWithQueryString"
 952    )
 953    body: Optional[str] = Field(default=None, alias="body")
 954    stage_variables: Optional[Mapping[str, str]] = Field(
 955        default=None, alias="stageVariables"
 956    )
 957    additional_context: Optional[Mapping[str, str]] = Field(
 958        default=None, alias="additionalContext"
 959    )
 960
 961
 962class TestInvokeMethodRequestModel(BaseModel):
 963    rest_api_id: str = Field(alias="restApiId")
 964    resource_id: str = Field(alias="resourceId")
 965    http_method: str = Field(alias="httpMethod")
 966    path_with_query_string: Optional[str] = Field(
 967        default=None, alias="pathWithQueryString"
 968    )
 969    body: Optional[str] = Field(default=None, alias="body")
 970    headers: Optional[Mapping[str, str]] = Field(default=None, alias="headers")
 971    multi_value_headers: Optional[Mapping[str, Sequence[str]]] = Field(
 972        default=None, alias="multiValueHeaders"
 973    )
 974    client_certificate_id: Optional[str] = Field(
 975        default=None, alias="clientCertificateId"
 976    )
 977    stage_variables: Optional[Mapping[str, str]] = Field(
 978        default=None, alias="stageVariables"
 979    )
 980
 981
 982class UntagResourceRequestModel(BaseModel):
 983    resource_arn: str = Field(alias="resourceArn")
 984    tag_keys: Sequence[str] = Field(alias="tagKeys")
 985
 986
 987class UsagePlanKeyModel(BaseModel):
 988    id: Optional[str] = Field(default=None, alias="id")
 989    type: Optional[str] = Field(default=None, alias="type")
 990    value: Optional[str] = Field(default=None, alias="value")
 991    name: Optional[str] = Field(default=None, alias="name")
 992
 993
 994class VpcLinkModel(BaseModel):
 995    id: Optional[str] = Field(default=None, alias="id")
 996    name: Optional[str] = Field(default=None, alias="name")
 997    description: Optional[str] = Field(default=None, alias="description")
 998    target_arns: Optional[List[str]] = Field(default=None, alias="targetArns")
 999    status: Optional[Literal["AVAILABLE", "DELETING", "FAILED", "PENDING"]] = Field(
1000        default=None, alias="status"
1001    )
1002    status_message: Optional[str] = Field(default=None, alias="statusMessage")
1003    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
1004
1005
1006class ApiKeyIdsModel(BaseModel):
1007    ids: List[str] = Field(alias="ids")
1008    warnings: List[str] = Field(alias="warnings")
1009    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1010
1011
1012class ApiKeyResponseMetadataModel(BaseModel):
1013    id: str = Field(alias="id")
1014    value: str = Field(alias="value")
1015    name: str = Field(alias="name")
1016    customer_id: str = Field(alias="customerId")
1017    description: str = Field(alias="description")
1018    enabled: bool = Field(alias="enabled")
1019    created_date: datetime = Field(alias="createdDate")
1020    last_updated_date: datetime = Field(alias="lastUpdatedDate")
1021    stage_keys: List[str] = Field(alias="stageKeys")
1022    tags: Dict[str, str] = Field(alias="tags")
1023    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1024
1025
1026class AuthorizerResponseMetadataModel(BaseModel):
1027    id: str = Field(alias="id")
1028    name: str = Field(alias="name")
1029    type: Literal["COGNITO_USER_POOLS", "REQUEST", "TOKEN"] = Field(alias="type")
1030    provider_arns: List[str] = Field(alias="providerARNs")
1031    auth_type: str = Field(alias="authType")
1032    authorizer_uri: str = Field(alias="authorizerUri")
1033    authorizer_credentials: str = Field(alias="authorizerCredentials")
1034    identity_source: str = Field(alias="identitySource")
1035    identity_validation_expression: str = Field(alias="identityValidationExpression")
1036    authorizer_result_ttl_in_seconds: int = Field(alias="authorizerResultTtlInSeconds")
1037    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1038
1039
1040class BasePathMappingResponseMetadataModel(BaseModel):
1041    base_path: str = Field(alias="basePath")
1042    rest_api_id: str = Field(alias="restApiId")
1043    stage: str = Field(alias="stage")
1044    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1045
1046
1047class ClientCertificateResponseMetadataModel(BaseModel):
1048    client_certificate_id: str = Field(alias="clientCertificateId")
1049    description: str = Field(alias="description")
1050    pem_encoded_certificate: str = Field(alias="pemEncodedCertificate")
1051    created_date: datetime = Field(alias="createdDate")
1052    expiration_date: datetime = Field(alias="expirationDate")
1053    tags: Dict[str, str] = Field(alias="tags")
1054    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1055
1056
1057class DocumentationPartIdsModel(BaseModel):
1058    ids: List[str] = Field(alias="ids")
1059    warnings: List[str] = Field(alias="warnings")
1060    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1061
1062
1063class DocumentationVersionResponseMetadataModel(BaseModel):
1064    version: str = Field(alias="version")
1065    created_date: datetime = Field(alias="createdDate")
1066    description: str = Field(alias="description")
1067    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1068
1069
1070class EmptyResponseMetadataModel(BaseModel):
1071    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1072
1073
1074class ExportResponseModel(BaseModel):
1075    content_type: str = Field(alias="contentType")
1076    content_disposition: str = Field(alias="contentDisposition")
1077    body: Type[StreamingBody] = Field(alias="body")
1078    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1079
1080
1081class GatewayResponseResponseMetadataModel(BaseModel):
1082    response_type: Literal[
1083        "ACCESS_DENIED",
1084        "API_CONFIGURATION_ERROR",
1085        "AUTHORIZER_CONFIGURATION_ERROR",
1086        "AUTHORIZER_FAILURE",
1087        "BAD_REQUEST_BODY",
1088        "BAD_REQUEST_PARAMETERS",
1089        "DEFAULT_4XX",
1090        "DEFAULT_5XX",
1091        "EXPIRED_TOKEN",
1092        "INTEGRATION_FAILURE",
1093        "INTEGRATION_TIMEOUT",
1094        "INVALID_API_KEY",
1095        "INVALID_SIGNATURE",
1096        "MISSING_AUTHENTICATION_TOKEN",
1097        "QUOTA_EXCEEDED",
1098        "REQUEST_TOO_LARGE",
1099        "RESOURCE_NOT_FOUND",
1100        "THROTTLED",
1101        "UNAUTHORIZED",
1102        "UNSUPPORTED_MEDIA_TYPE",
1103        "WAF_FILTERED",
1104    ] = Field(alias="responseType")
1105    status_code: str = Field(alias="statusCode")
1106    response_parameters: Dict[str, str] = Field(alias="responseParameters")
1107    response_templates: Dict[str, str] = Field(alias="responseTemplates")
1108    default_response: bool = Field(alias="defaultResponse")
1109    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1110
1111
1112class IntegrationResponseResponseMetadataModel(BaseModel):
1113    status_code: str = Field(alias="statusCode")
1114    selection_pattern: str = Field(alias="selectionPattern")
1115    response_parameters: Dict[str, str] = Field(alias="responseParameters")
1116    response_templates: Dict[str, str] = Field(alias="responseTemplates")
1117    content_handling: Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"] = Field(
1118        alias="contentHandling"
1119    )
1120    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1121
1122
1123class MethodResponseResponseMetadataModel(BaseModel):
1124    status_code: str = Field(alias="statusCode")
1125    response_parameters: Dict[str, bool] = Field(alias="responseParameters")
1126    response_models: Dict[str, str] = Field(alias="responseModels")
1127    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1128
1129
1130class ModelResponseMetadataModel(BaseModel):
1131    id: str = Field(alias="id")
1132    name: str = Field(alias="name")
1133    description: str = Field(alias="description")
1134    schema_: str = Field(alias="schema")
1135    content_type: str = Field(alias="contentType")
1136    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1137
1138
1139class RequestValidatorResponseMetadataModel(BaseModel):
1140    id: str = Field(alias="id")
1141    name: str = Field(alias="name")
1142    validate_request_body: bool = Field(alias="validateRequestBody")
1143    validate_request_parameters: bool = Field(alias="validateRequestParameters")
1144    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1145
1146
1147class SdkResponseModel(BaseModel):
1148    content_type: str = Field(alias="contentType")
1149    content_disposition: str = Field(alias="contentDisposition")
1150    body: Type[StreamingBody] = Field(alias="body")
1151    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1152
1153
1154class TagsModel(BaseModel):
1155    tags: Dict[str, str] = Field(alias="tags")
1156    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1157
1158
1159class TemplateModel(BaseModel):
1160    value: str = Field(alias="value")
1161    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1162
1163
1164class TestInvokeAuthorizerResponseModel(BaseModel):
1165    client_status: int = Field(alias="clientStatus")
1166    log: str = Field(alias="log")
1167    latency: int = Field(alias="latency")
1168    principal_id: str = Field(alias="principalId")
1169    policy: str = Field(alias="policy")
1170    authorization: Dict[str, List[str]] = Field(alias="authorization")
1171    claims: Dict[str, str] = Field(alias="claims")
1172    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1173
1174
1175class TestInvokeMethodResponseModel(BaseModel):
1176    status: int = Field(alias="status")
1177    body: str = Field(alias="body")
1178    headers: Dict[str, str] = Field(alias="headers")
1179    multi_value_headers: Dict[str, List[str]] = Field(alias="multiValueHeaders")
1180    log: str = Field(alias="log")
1181    latency: int = Field(alias="latency")
1182    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1183
1184
1185class UsagePlanKeyResponseMetadataModel(BaseModel):
1186    id: str = Field(alias="id")
1187    type: str = Field(alias="type")
1188    value: str = Field(alias="value")
1189    name: str = Field(alias="name")
1190    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1191
1192
1193class UsageModel(BaseModel):
1194    usage_plan_id: str = Field(alias="usagePlanId")
1195    start_date: str = Field(alias="startDate")
1196    end_date: str = Field(alias="endDate")
1197    position: str = Field(alias="position")
1198    items: Dict[str, List[List[int]]] = Field(alias="items")
1199    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1200
1201
1202class VpcLinkResponseMetadataModel(BaseModel):
1203    id: str = Field(alias="id")
1204    name: str = Field(alias="name")
1205    description: str = Field(alias="description")
1206    target_arns: List[str] = Field(alias="targetArns")
1207    status: Literal["AVAILABLE", "DELETING", "FAILED", "PENDING"] = Field(
1208        alias="status"
1209    )
1210    status_message: str = Field(alias="statusMessage")
1211    tags: Dict[str, str] = Field(alias="tags")
1212    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1213
1214
1215class AccountModel(BaseModel):
1216    cloudwatch_role_arn: str = Field(alias="cloudwatchRoleArn")
1217    throttle_settings: ThrottleSettingsModel = Field(alias="throttleSettings")
1218    features: List[str] = Field(alias="features")
1219    api_key_version: str = Field(alias="apiKeyVersion")
1220    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1221
1222
1223class ApiStageModel(BaseModel):
1224    api_id: Optional[str] = Field(default=None, alias="apiId")
1225    stage: Optional[str] = Field(default=None, alias="stage")
1226    throttle: Optional[Mapping[str, ThrottleSettingsModel]] = Field(
1227        default=None, alias="throttle"
1228    )
1229
1230
1231class ApiKeysModel(BaseModel):
1232    warnings: List[str] = Field(alias="warnings")
1233    position: str = Field(alias="position")
1234    items: List[ApiKeyModel] = Field(alias="items")
1235    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1236
1237
1238class AuthorizersModel(BaseModel):
1239    position: str = Field(alias="position")
1240    items: List[AuthorizerModel] = Field(alias="items")
1241    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1242
1243
1244class BasePathMappingsModel(BaseModel):
1245    position: str = Field(alias="position")
1246    items: List[BasePathMappingModel] = Field(alias="items")
1247    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1248
1249
1250class CreateStageRequestModel(BaseModel):
1251    rest_api_id: str = Field(alias="restApiId")
1252    stage_name: str = Field(alias="stageName")
1253    deployment_id: str = Field(alias="deploymentId")
1254    description: Optional[str] = Field(default=None, alias="description")
1255    cache_cluster_enabled: Optional[bool] = Field(
1256        default=None, alias="cacheClusterEnabled"
1257    )
1258    cache_cluster_size: Optional[
1259        Literal["0.5", "1.6", "118", "13.5", "237", "28.4", "58.2", "6.1"]
1260    ] = Field(default=None, alias="cacheClusterSize")
1261    variables: Optional[Mapping[str, str]] = Field(default=None, alias="variables")
1262    documentation_version: Optional[str] = Field(
1263        default=None, alias="documentationVersion"
1264    )
1265    canary_settings: Optional[CanarySettingsModel] = Field(
1266        default=None, alias="canarySettings"
1267    )
1268    tracing_enabled: Optional[bool] = Field(default=None, alias="tracingEnabled")
1269    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
1270
1271
1272class ClientCertificatesModel(BaseModel):
1273    position: str = Field(alias="position")
1274    items: List[ClientCertificateModel] = Field(alias="items")
1275    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1276
1277
1278class CreateApiKeyRequestModel(BaseModel):
1279    name: Optional[str] = Field(default=None, alias="name")
1280    description: Optional[str] = Field(default=None, alias="description")
1281    enabled: Optional[bool] = Field(default=None, alias="enabled")
1282    generate_distinct_id: Optional[bool] = Field(
1283        default=None, alias="generateDistinctId"
1284    )
1285    value: Optional[str] = Field(default=None, alias="value")
1286    stage_keys: Optional[Sequence[StageKeyModel]] = Field(
1287        default=None, alias="stageKeys"
1288    )
1289    customer_id: Optional[str] = Field(default=None, alias="customerId")
1290    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
1291
1292
1293class CreateDeploymentRequestModel(BaseModel):
1294    rest_api_id: str = Field(alias="restApiId")
1295    stage_name: Optional[str] = Field(default=None, alias="stageName")
1296    stage_description: Optional[str] = Field(default=None, alias="stageDescription")
1297    description: Optional[str] = Field(default=None, alias="description")
1298    cache_cluster_enabled: Optional[bool] = Field(
1299        default=None, alias="cacheClusterEnabled"
1300    )
1301    cache_cluster_size: Optional[
1302        Literal["0.5", "1.6", "118", "13.5", "237", "28.4", "58.2", "6.1"]
1303    ] = Field(default=None, alias="cacheClusterSize")
1304    variables: Optional[Mapping[str, str]] = Field(default=None, alias="variables")
1305    canary_settings: Optional[DeploymentCanarySettingsModel] = Field(
1306        default=None, alias="canarySettings"
1307    )
1308    tracing_enabled: Optional[bool] = Field(default=None, alias="tracingEnabled")
1309
1310
1311class CreateDocumentationPartRequestModel(BaseModel):
1312    rest_api_id: str = Field(alias="restApiId")
1313    location: DocumentationPartLocationModel = Field(alias="location")
1314    properties: str = Field(alias="properties")
1315
1316
1317class DocumentationPartResponseMetadataModel(BaseModel):
1318    id: str = Field(alias="id")
1319    location: DocumentationPartLocationModel = Field(alias="location")
1320    properties: str = Field(alias="properties")
1321    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1322
1323
1324class DocumentationPartModel(BaseModel):
1325    id: Optional[str] = Field(default=None, alias="id")
1326    location: Optional[DocumentationPartLocationModel] = Field(
1327        default=None, alias="location"
1328    )
1329    properties: Optional[str] = Field(default=None, alias="properties")
1330
1331
1332class CreateRestApiRequestModel(BaseModel):
1333    name: str = Field(alias="name")
1334    description: Optional[str] = Field(default=None, alias="description")
1335    version: Optional[str] = Field(default=None, alias="version")
1336    clone_from: Optional[str] = Field(default=None, alias="cloneFrom")
1337    binary_media_types: Optional[Sequence[str]] = Field(
1338        default=None, alias="binaryMediaTypes"
1339    )
1340    minimum_compression_size: Optional[int] = Field(
1341        default=None, alias="minimumCompressionSize"
1342    )
1343    api_key_source: Optional[Literal["AUTHORIZER", "HEADER"]] = Field(
1344        default=None, alias="apiKeySource"
1345    )
1346    endpoint_configuration: Optional[EndpointConfigurationModel] = Field(
1347        default=None, alias="endpointConfiguration"
1348    )
1349    policy: Optional[str] = Field(default=None, alias="policy")
1350    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
1351    disable_execute_api_endpoint: Optional[bool] = Field(
1352        default=None, alias="disableExecuteApiEndpoint"
1353    )
1354
1355
1356class RestApiResponseMetadataModel(BaseModel):
1357    id: str = Field(alias="id")
1358    name: str = Field(alias="name")
1359    description: str = Field(alias="description")
1360    created_date: datetime = Field(alias="createdDate")
1361    version: str = Field(alias="version")
1362    warnings: List[str] = Field(alias="warnings")
1363    binary_media_types: List[str] = Field(alias="binaryMediaTypes")
1364    minimum_compression_size: int = Field(alias="minimumCompressionSize")
1365    api_key_source: Literal["AUTHORIZER", "HEADER"] = Field(alias="apiKeySource")
1366    endpoint_configuration: EndpointConfigurationModel = Field(
1367        alias="endpointConfiguration"
1368    )
1369    policy: str = Field(alias="policy")
1370    tags: Dict[str, str] = Field(alias="tags")
1371    disable_execute_api_endpoint: bool = Field(alias="disableExecuteApiEndpoint")
1372    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1373
1374
1375class RestApiModel(BaseModel):
1376    id: Optional[str] = Field(default=None, alias="id")
1377    name: Optional[str] = Field(default=None, alias="name")
1378    description: Optional[str] = Field(default=None, alias="description")
1379    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
1380    version: Optional[str] = Field(default=None, alias="version")
1381    warnings: Optional[List[str]] = Field(default=None, alias="warnings")
1382    binary_media_types: Optional[List[str]] = Field(
1383        default=None, alias="binaryMediaTypes"
1384    )
1385    minimum_compression_size: Optional[int] = Field(
1386        default=None, alias="minimumCompressionSize"
1387    )
1388    api_key_source: Optional[Literal["AUTHORIZER", "HEADER"]] = Field(
1389        default=None, alias="apiKeySource"
1390    )
1391    endpoint_configuration: Optional[EndpointConfigurationModel] = Field(
1392        default=None, alias="endpointConfiguration"
1393    )
1394    policy: Optional[str] = Field(default=None, alias="policy")
1395    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
1396    disable_execute_api_endpoint: Optional[bool] = Field(
1397        default=None, alias="disableExecuteApiEndpoint"
1398    )
1399
1400
1401class CreateDomainNameRequestModel(BaseModel):
1402    domain_name: str = Field(alias="domainName")
1403    certificate_name: Optional[str] = Field(default=None, alias="certificateName")
1404    certificate_body: Optional[str] = Field(default=None, alias="certificateBody")
1405    certificate_private_key: Optional[str] = Field(
1406        default=None, alias="certificatePrivateKey"
1407    )
1408    certificate_chain: Optional[str] = Field(default=None, alias="certificateChain")
1409    certificate_arn: Optional[str] = Field(default=None, alias="certificateArn")
1410    regional_certificate_name: Optional[str] = Field(
1411        default=None, alias="regionalCertificateName"
1412    )
1413    regional_certificate_arn: Optional[str] = Field(
1414        default=None, alias="regionalCertificateArn"
1415    )
1416    endpoint_configuration: Optional[EndpointConfigurationModel] = Field(
1417        default=None, alias="endpointConfiguration"
1418    )
1419    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
1420    security_policy: Optional[Literal["TLS_1_0", "TLS_1_2"]] = Field(
1421        default=None, alias="securityPolicy"
1422    )
1423    mutual_tls_authentication: Optional[MutualTlsAuthenticationInputModel] = Field(
1424        default=None, alias="mutualTlsAuthentication"
1425    )
1426    ownership_verification_certificate_arn: Optional[str] = Field(
1427        default=None, alias="ownershipVerificationCertificateArn"
1428    )
1429
1430
1431class DeploymentResponseMetadataModel(BaseModel):
1432    id: str = Field(alias="id")
1433    description: str = Field(alias="description")
1434    created_date: datetime = Field(alias="createdDate")
1435    api_summary: Dict[str, Dict[str, MethodSnapshotModel]] = Field(alias="apiSummary")
1436    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1437
1438
1439class DeploymentModel(BaseModel):
1440    id: Optional[str] = Field(default=None, alias="id")
1441    description: Optional[str] = Field(default=None, alias="description")
1442    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
1443    api_summary: Optional[Dict[str, Dict[str, MethodSnapshotModel]]] = Field(
1444        default=None, alias="apiSummary"
1445    )
1446
1447
1448class DocumentationVersionsModel(BaseModel):
1449    position: str = Field(alias="position")
1450    items: List[DocumentationVersionModel] = Field(alias="items")
1451    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1452
1453
1454class DomainNameResponseMetadataModel(BaseModel):
1455    domain_name: str = Field(alias="domainName")
1456    certificate_name: str = Field(alias="certificateName")
1457    certificate_arn: str = Field(alias="certificateArn")
1458    certificate_upload_date: datetime = Field(alias="certificateUploadDate")
1459    regional_domain_name: str = Field(alias="regionalDomainName")
1460    regional_hosted_zone_id: str = Field(alias="regionalHostedZoneId")
1461    regional_certificate_name: str = Field(alias="regionalCertificateName")
1462    regional_certificate_arn: str = Field(alias="regionalCertificateArn")
1463    distribution_domain_name: str = Field(alias="distributionDomainName")
1464    distribution_hosted_zone_id: str = Field(alias="distributionHostedZoneId")
1465    endpoint_configuration: EndpointConfigurationModel = Field(
1466        alias="endpointConfiguration"
1467    )
1468    domain_name_status: Literal[
1469        "AVAILABLE",
1470        "PENDING",
1471        "PENDING_CERTIFICATE_REIMPORT",
1472        "PENDING_OWNERSHIP_VERIFICATION",
1473        "UPDATING",
1474    ] = Field(alias="domainNameStatus")
1475    domain_name_status_message: str = Field(alias="domainNameStatusMessage")
1476    security_policy: Literal["TLS_1_0", "TLS_1_2"] = Field(alias="securityPolicy")
1477    tags: Dict[str, str] = Field(alias="tags")
1478    mutual_tls_authentication: MutualTlsAuthenticationModel = Field(
1479        alias="mutualTlsAuthentication"
1480    )
1481    ownership_verification_certificate_arn: str = Field(
1482        alias="ownershipVerificationCertificateArn"
1483    )
1484    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1485
1486
1487class DomainNameModel(BaseModel):
1488    domain_name: Optional[str] = Field(default=None, alias="domainName")
1489    certificate_name: Optional[str] = Field(default=None, alias="certificateName")
1490    certificate_arn: Optional[str] = Field(default=None, alias="certificateArn")
1491    certificate_upload_date: Optional[datetime] = Field(
1492        default=None, alias="certificateUploadDate"
1493    )
1494    regional_domain_name: Optional[str] = Field(
1495        default=None, alias="regionalDomainName"
1496    )
1497    regional_hosted_zone_id: Optional[str] = Field(
1498        default=None, alias="regionalHostedZoneId"
1499    )
1500    regional_certificate_name: Optional[str] = Field(
1501        default=None, alias="regionalCertificateName"
1502    )
1503    regional_certificate_arn: Optional[str] = Field(
1504        default=None, alias="regionalCertificateArn"
1505    )
1506    distribution_domain_name: Optional[str] = Field(
1507        default=None, alias="distributionDomainName"
1508    )
1509    distribution_hosted_zone_id: Optional[str] = Field(
1510        default=None, alias="distributionHostedZoneId"
1511    )
1512    endpoint_configuration: Optional[EndpointConfigurationModel] = Field(
1513        default=None, alias="endpointConfiguration"
1514    )
1515    domain_name_status: Optional[
1516        Literal[
1517            "AVAILABLE",
1518            "PENDING",
1519            "PENDING_CERTIFICATE_REIMPORT",
1520            "PENDING_OWNERSHIP_VERIFICATION",
1521            "UPDATING",
1522        ]
1523    ] = Field(default=None, alias="domainNameStatus")
1524    domain_name_status_message: Optional[str] = Field(
1525        default=None, alias="domainNameStatusMessage"
1526    )
1527    security_policy: Optional[Literal["TLS_1_0", "TLS_1_2"]] = Field(
1528        default=None, alias="securityPolicy"
1529    )
1530    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
1531    mutual_tls_authentication: Optional[MutualTlsAuthenticationModel] = Field(
1532        default=None, alias="mutualTlsAuthentication"
1533    )
1534    ownership_verification_certificate_arn: Optional[str] = Field(
1535        default=None, alias="ownershipVerificationCertificateArn"
1536    )
1537
1538
1539class GatewayResponsesModel(BaseModel):
1540    position: str = Field(alias="position")
1541    items: List[GatewayResponseModel] = Field(alias="items")
1542    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1543
1544
1545class GetApiKeysRequestGetApiKeysPaginateModel(BaseModel):
1546    name_query: Optional[str] = Field(default=None, alias="nameQuery")
1547    customer_id: Optional[str] = Field(default=None, alias="customerId")
1548    include_values: Optional[bool] = Field(default=None, alias="includeValues")
1549    pagination_config: Optional[PaginatorConfigModel] = Field(
1550        default=None, alias="PaginationConfig"
1551    )
1552
1553
1554class GetAuthorizersRequestGetAuthorizersPaginateModel(BaseModel):
1555    rest_api_id: str = Field(alias="restApiId")
1556    pagination_config: Optional[PaginatorConfigModel] = Field(
1557        default=None, alias="PaginationConfig"
1558    )
1559
1560
1561class GetBasePathMappingsRequestGetBasePathMappingsPaginateModel(BaseModel):
1562    domain_name: str = Field(alias="domainName")
1563    pagination_config: Optional[PaginatorConfigModel] = Field(
1564        default=None, alias="PaginationConfig"
1565    )
1566
1567
1568class GetClientCertificatesRequestGetClientCertificatesPaginateModel(BaseModel):
1569    pagination_config: Optional[PaginatorConfigModel] = Field(
1570        default=None, alias="PaginationConfig"
1571    )
1572
1573
1574class GetDeploymentsRequestGetDeploymentsPaginateModel(BaseModel):
1575    rest_api_id: str = Field(alias="restApiId")
1576    pagination_config: Optional[PaginatorConfigModel] = Field(
1577        default=None, alias="PaginationConfig"
1578    )
1579
1580
1581class GetDocumentationPartsRequestGetDocumentationPartsPaginateModel(BaseModel):
1582    rest_api_id: str = Field(alias="restApiId")
1583    type: Optional[
1584        Literal[
1585            "API",
1586            "AUTHORIZER",
1587            "METHOD",
1588            "MODEL",
1589            "PATH_PARAMETER",
1590            "QUERY_PARAMETER",
1591            "REQUEST_BODY",
1592            "REQUEST_HEADER",
1593            "RESOURCE",
1594            "RESPONSE",
1595            "RESPONSE_BODY",
1596            "RESPONSE_HEADER",
1597        ]
1598    ] = Field(default=None, alias="type")
1599    name_query: Optional[str] = Field(default=None, alias="nameQuery")
1600    path: Optional[str] = Field(default=None, alias="path")
1601    location_status: Optional[Literal["DOCUMENTED", "UNDOCUMENTED"]] = Field(
1602        default=None, alias="locationStatus"
1603    )
1604    pagination_config: Optional[PaginatorConfigModel] = Field(
1605        default=None, alias="PaginationConfig"
1606    )
1607
1608
1609class GetDocumentationVersionsRequestGetDocumentationVersionsPaginateModel(BaseModel):
1610    rest_api_id: str = Field(alias="restApiId")
1611    pagination_config: Optional[PaginatorConfigModel] = Field(
1612        default=None, alias="PaginationConfig"
1613    )
1614
1615
1616class GetDomainNamesRequestGetDomainNamesPaginateModel(BaseModel):
1617    pagination_config: Optional[PaginatorConfigModel] = Field(
1618        default=None, alias="PaginationConfig"
1619    )
1620
1621
1622class GetGatewayResponsesRequestGetGatewayResponsesPaginateModel(BaseModel):
1623    rest_api_id: str = Field(alias="restApiId")
1624    pagination_config: Optional[PaginatorConfigModel] = Field(
1625        default=None, alias="PaginationConfig"
1626    )
1627
1628
1629class GetModelsRequestGetModelsPaginateModel(BaseModel):
1630    rest_api_id: str = Field(alias="restApiId")
1631    pagination_config: Optional[PaginatorConfigModel] = Field(
1632        default=None, alias="PaginationConfig"
1633    )
1634
1635
1636class GetRequestValidatorsRequestGetRequestValidatorsPaginateModel(BaseModel):
1637    rest_api_id: str = Field(alias="restApiId")
1638    pagination_config: Optional[PaginatorConfigModel] = Field(
1639        default=None, alias="PaginationConfig"
1640    )
1641
1642
1643class GetResourcesRequestGetResourcesPaginateModel(BaseModel):
1644    rest_api_id: str = Field(alias="restApiId")
1645    embed: Optional[Sequence[str]] = Field(default=None, alias="embed")
1646    pagination_config: Optional[PaginatorConfigModel] = Field(
1647        default=None, alias="PaginationConfig"
1648    )
1649
1650
1651class GetRestApisRequestGetRestApisPaginateModel(BaseModel):
1652    pagination_config: Optional[PaginatorConfigModel] = Field(
1653        default=None, alias="PaginationConfig"
1654    )
1655
1656
1657class GetSdkTypesRequestGetSdkTypesPaginateModel(BaseModel):
1658    pagination_config: Optional[PaginatorConfigModel] = Field(
1659        default=None, alias="PaginationConfig"
1660    )
1661
1662
1663class GetUsagePlanKeysRequestGetUsagePlanKeysPaginateModel(BaseModel):
1664    usage_plan_id: str = Field(alias="usagePlanId")
1665    name_query: Optional[str] = Field(default=None, alias="nameQuery")
1666    pagination_config: Optional[PaginatorConfigModel] = Field(
1667        default=None, alias="PaginationConfig"
1668    )
1669
1670
1671class GetUsagePlansRequestGetUsagePlansPaginateModel(BaseModel):
1672    key_id: Optional[str] = Field(default=None, alias="keyId")
1673    pagination_config: Optional[PaginatorConfigModel] = Field(
1674        default=None, alias="PaginationConfig"
1675    )
1676
1677
1678class GetUsageRequestGetUsagePaginateModel(BaseModel):
1679    usage_plan_id: str = Field(alias="usagePlanId")
1680    start_date: str = Field(alias="startDate")
1681    end_date: str = Field(alias="endDate")
1682    key_id: Optional[str] = Field(default=None, alias="keyId")
1683    pagination_config: Optional[PaginatorConfigModel] = Field(
1684        default=None, alias="PaginationConfig"
1685    )
1686
1687
1688class GetVpcLinksRequestGetVpcLinksPaginateModel(BaseModel):
1689    pagination_config: Optional[PaginatorConfigModel] = Field(
1690        default=None, alias="PaginationConfig"
1691    )
1692
1693
1694class IntegrationResponseMetadataModel(BaseModel):
1695    type: Literal["AWS", "AWS_PROXY", "HTTP", "HTTP_PROXY", "MOCK"] = Field(
1696        alias="type"
1697    )
1698    http_method: str = Field(alias="httpMethod")
1699    uri: str = Field(alias="uri")
1700    connection_type: Literal["INTERNET", "VPC_LINK"] = Field(alias="connectionType")
1701    connection_id: str = Field(alias="connectionId")
1702    credentials: str = Field(alias="credentials")
1703    request_parameters: Dict[str, str] = Field(alias="requestParameters")
1704    request_templates: Dict[str, str] = Field(alias="requestTemplates")
1705    passthrough_behavior: str = Field(alias="passthroughBehavior")
1706    content_handling: Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"] = Field(
1707        alias="contentHandling"
1708    )
1709    timeout_in_millis: int = Field(alias="timeoutInMillis")
1710    cache_namespace: str = Field(alias="cacheNamespace")
1711    cache_key_parameters: List[str] = Field(alias="cacheKeyParameters")
1712    integration_responses: Dict[str, IntegrationResponseModel] = Field(
1713        alias="integrationResponses"
1714    )
1715    tls_config: TlsConfigModel = Field(alias="tlsConfig")
1716    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1717
1718
1719class IntegrationModel(BaseModel):
1720    type: Optional[Literal["AWS", "AWS_PROXY", "HTTP", "HTTP_PROXY", "MOCK"]] = Field(
1721        default=None, alias="type"
1722    )
1723    http_method: Optional[str] = Field(default=None, alias="httpMethod")
1724    uri: Optional[str] = Field(default=None, alias="uri")
1725    connection_type: Optional[Literal["INTERNET", "VPC_LINK"]] = Field(
1726        default=None, alias="connectionType"
1727    )
1728    connection_id: Optional[str] = Field(default=None, alias="connectionId")
1729    credentials: Optional[str] = Field(default=None, alias="credentials")
1730    request_parameters: Optional[Dict[str, str]] = Field(
1731        default=None, alias="requestParameters"
1732    )
1733    request_templates: Optional[Dict[str, str]] = Field(
1734        default=None, alias="requestTemplates"
1735    )
1736    passthrough_behavior: Optional[str] = Field(
1737        default=None, alias="passthroughBehavior"
1738    )
1739    content_handling: Optional[Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"]] = Field(
1740        default=None, alias="contentHandling"
1741    )
1742    timeout_in_millis: Optional[int] = Field(default=None, alias="timeoutInMillis")
1743    cache_namespace: Optional[str] = Field(default=None, alias="cacheNamespace")
1744    cache_key_parameters: Optional[List[str]] = Field(
1745        default=None, alias="cacheKeyParameters"
1746    )
1747    integration_responses: Optional[Dict[str, IntegrationResponseModel]] = Field(
1748        default=None, alias="integrationResponses"
1749    )
1750    tls_config: Optional[TlsConfigModel] = Field(default=None, alias="tlsConfig")
1751
1752
1753class PutIntegrationRequestModel(BaseModel):
1754    rest_api_id: str = Field(alias="restApiId")
1755    resource_id: str = Field(alias="resourceId")
1756    http_method: str = Field(alias="httpMethod")
1757    type: Literal["AWS", "AWS_PROXY", "HTTP", "HTTP_PROXY", "MOCK"] = Field(
1758        alias="type"
1759    )
1760    integration_http_method: Optional[str] = Field(
1761        default=None, alias="integrationHttpMethod"
1762    )
1763    uri: Optional[str] = Field(default=None, alias="uri")
1764    connection_type: Optional[Literal["INTERNET", "VPC_LINK"]] = Field(
1765        default=None, alias="connectionType"
1766    )
1767    connection_id: Optional[str] = Field(default=None, alias="connectionId")
1768    credentials: Optional[str] = Field(default=None, alias="credentials")
1769    request_parameters: Optional[Mapping[str, str]] = Field(
1770        default=None, alias="requestParameters"
1771    )
1772    request_templates: Optional[Mapping[str, str]] = Field(
1773        default=None, alias="requestTemplates"
1774    )
1775    passthrough_behavior: Optional[str] = Field(
1776        default=None, alias="passthroughBehavior"
1777    )
1778    cache_namespace: Optional[str] = Field(default=None, alias="cacheNamespace")
1779    cache_key_parameters: Optional[Sequence[str]] = Field(
1780        default=None, alias="cacheKeyParameters"
1781    )
1782    content_handling: Optional[Literal["CONVERT_TO_BINARY", "CONVERT_TO_TEXT"]] = Field(
1783        default=None, alias="contentHandling"
1784    )
1785    timeout_in_millis: Optional[int] = Field(default=None, alias="timeoutInMillis")
1786    tls_config: Optional[TlsConfigModel] = Field(default=None, alias="tlsConfig")
1787
1788
1789class StageResponseMetadataModel(BaseModel):
1790    deployment_id: str = Field(alias="deploymentId")
1791    client_certificate_id: str = Field(alias="clientCertificateId")
1792    stage_name: str = Field(alias="stageName")
1793    description: str = Field(alias="description")
1794    cache_cluster_enabled: bool = Field(alias="cacheClusterEnabled")
1795    cache_cluster_size: Literal[
1796        "0.5", "1.6", "118", "13.5", "237", "28.4", "58.2", "6.1"
1797    ] = Field(alias="cacheClusterSize")
1798    cache_cluster_status: Literal[
1799        "AVAILABLE",
1800        "CREATE_IN_PROGRESS",
1801        "DELETE_IN_PROGRESS",
1802        "FLUSH_IN_PROGRESS",
1803        "NOT_AVAILABLE",
1804    ] = Field(alias="cacheClusterStatus")
1805    method_settings: Dict[str, MethodSettingModel] = Field(alias="methodSettings")
1806    variables: Dict[str, str] = Field(alias="variables")
1807    documentation_version: str = Field(alias="documentationVersion")
1808    access_log_settings: AccessLogSettingsModel = Field(alias="accessLogSettings")
1809    canary_settings: CanarySettingsModel = Field(alias="canarySettings")
1810    tracing_enabled: bool = Field(alias="tracingEnabled")
1811    web_acl_arn: str = Field(alias="webAclArn")
1812    tags: Dict[str, str] = Field(alias="tags")
1813    created_date: datetime = Field(alias="createdDate")
1814    last_updated_date: datetime = Field(alias="lastUpdatedDate")
1815    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1816
1817
1818class StageModel(BaseModel):
1819    deployment_id: Optional[str] = Field(default=None, alias="deploymentId")
1820    client_certificate_id: Optional[str] = Field(
1821        default=None, alias="clientCertificateId"
1822    )
1823    stage_name: Optional[str] = Field(default=None, alias="stageName")
1824    description: Optional[str] = Field(default=None, alias="description")
1825    cache_cluster_enabled: Optional[bool] = Field(
1826        default=None, alias="cacheClusterEnabled"
1827    )
1828    cache_cluster_size: Optional[
1829        Literal["0.5", "1.6", "118", "13.5", "237", "28.4", "58.2", "6.1"]
1830    ] = Field(default=None, alias="cacheClusterSize")
1831    cache_cluster_status: Optional[
1832        Literal[
1833            "AVAILABLE",
1834            "CREATE_IN_PROGRESS",
1835            "DELETE_IN_PROGRESS",
1836            "FLUSH_IN_PROGRESS",
1837            "NOT_AVAILABLE",
1838        ]
1839    ] = Field(default=None, alias="cacheClusterStatus")
1840    method_settings: Optional[Dict[str, MethodSettingModel]] = Field(
1841        default=None, alias="methodSettings"
1842    )
1843    variables: Optional[Dict[str, str]] = Field(default=None, alias="variables")
1844    documentation_version: Optional[str] = Field(
1845        default=None, alias="documentationVersion"
1846    )
1847    access_log_settings: Optional[AccessLogSettingsModel] = Field(
1848        default=None, alias="accessLogSettings"
1849    )
1850    canary_settings: Optional[CanarySettingsModel] = Field(
1851        default=None, alias="canarySettings"
1852    )
1853    tracing_enabled: Optional[bool] = Field(default=None, alias="tracingEnabled")
1854    web_acl_arn: Optional[str] = Field(default=None, alias="webAclArn")
1855    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
1856    created_date: Optional[datetime] = Field(default=None, alias="createdDate")
1857    last_updated_date: Optional[datetime] = Field(default=None, alias="lastUpdatedDate")
1858
1859
1860class ModelsModel(BaseModel):
1861    position: str = Field(alias="position")
1862    items: List[ModelModel] = Field(alias="items")
1863    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
1864
1865
1866class UpdateAccountRequestModel(BaseModel):
1867    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1868        default=None, alias="patchOperations"
1869    )
1870
1871
1872class UpdateApiKeyRequestModel(BaseModel):
1873    api_key: str = Field(alias="apiKey")
1874    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1875        default=None, alias="patchOperations"
1876    )
1877
1878
1879class UpdateAuthorizerRequestModel(BaseModel):
1880    rest_api_id: str = Field(alias="restApiId")
1881    authorizer_id: str = Field(alias="authorizerId")
1882    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1883        default=None, alias="patchOperations"
1884    )
1885
1886
1887class UpdateBasePathMappingRequestModel(BaseModel):
1888    domain_name: str = Field(alias="domainName")
1889    base_path: str = Field(alias="basePath")
1890    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1891        default=None, alias="patchOperations"
1892    )
1893
1894
1895class UpdateClientCertificateRequestModel(BaseModel):
1896    client_certificate_id: str = Field(alias="clientCertificateId")
1897    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1898        default=None, alias="patchOperations"
1899    )
1900
1901
1902class UpdateDeploymentRequestModel(BaseModel):
1903    rest_api_id: str = Field(alias="restApiId")
1904    deployment_id: str = Field(alias="deploymentId")
1905    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1906        default=None, alias="patchOperations"
1907    )
1908
1909
1910class UpdateDocumentationPartRequestModel(BaseModel):
1911    rest_api_id: str = Field(alias="restApiId")
1912    documentation_part_id: str = Field(alias="documentationPartId")
1913    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1914        default=None, alias="patchOperations"
1915    )
1916
1917
1918class UpdateDocumentationVersionRequestModel(BaseModel):
1919    rest_api_id: str = Field(alias="restApiId")
1920    documentation_version: str = Field(alias="documentationVersion")
1921    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1922        default=None, alias="patchOperations"
1923    )
1924
1925
1926class UpdateDomainNameRequestModel(BaseModel):
1927    domain_name: str = Field(alias="domainName")
1928    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1929        default=None, alias="patchOperations"
1930    )
1931
1932
1933class UpdateGatewayResponseRequestModel(BaseModel):
1934    rest_api_id: str = Field(alias="restApiId")
1935    response_type: Literal[
1936        "ACCESS_DENIED",
1937        "API_CONFIGURATION_ERROR",
1938        "AUTHORIZER_CONFIGURATION_ERROR",
1939        "AUTHORIZER_FAILURE",
1940        "BAD_REQUEST_BODY",
1941        "BAD_REQUEST_PARAMETERS",
1942        "DEFAULT_4XX",
1943        "DEFAULT_5XX",
1944        "EXPIRED_TOKEN",
1945        "INTEGRATION_FAILURE",
1946        "INTEGRATION_TIMEOUT",
1947        "INVALID_API_KEY",
1948        "INVALID_SIGNATURE",
1949        "MISSING_AUTHENTICATION_TOKEN",
1950        "QUOTA_EXCEEDED",
1951        "REQUEST_TOO_LARGE",
1952        "RESOURCE_NOT_FOUND",
1953        "THROTTLED",
1954        "UNAUTHORIZED",
1955        "UNSUPPORTED_MEDIA_TYPE",
1956        "WAF_FILTERED",
1957    ] = Field(alias="responseType")
1958    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1959        default=None, alias="patchOperations"
1960    )
1961
1962
1963class UpdateIntegrationRequestModel(BaseModel):
1964    rest_api_id: str = Field(alias="restApiId")
1965    resource_id: str = Field(alias="resourceId")
1966    http_method: str = Field(alias="httpMethod")
1967    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1968        default=None, alias="patchOperations"
1969    )
1970
1971
1972class UpdateIntegrationResponseRequestModel(BaseModel):
1973    rest_api_id: str = Field(alias="restApiId")
1974    resource_id: str = Field(alias="resourceId")
1975    http_method: str = Field(alias="httpMethod")
1976    status_code: str = Field(alias="statusCode")
1977    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1978        default=None, alias="patchOperations"
1979    )
1980
1981
1982class UpdateMethodRequestModel(BaseModel):
1983    rest_api_id: str = Field(alias="restApiId")
1984    resource_id: str = Field(alias="resourceId")
1985    http_method: str = Field(alias="httpMethod")
1986    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1987        default=None, alias="patchOperations"
1988    )
1989
1990
1991class UpdateMethodResponseRequestModel(BaseModel):
1992    rest_api_id: str = Field(alias="restApiId")
1993    resource_id: str = Field(alias="resourceId")
1994    http_method: str = Field(alias="httpMethod")
1995    status_code: str = Field(alias="statusCode")
1996    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
1997        default=None, alias="patchOperations"
1998    )
1999
2000
2001class UpdateModelRequestModel(BaseModel):
2002    rest_api_id: str = Field(alias="restApiId")
2003    model_name: str = Field(alias="modelName")
2004    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2005        default=None, alias="patchOperations"
2006    )
2007
2008
2009class UpdateRequestValidatorRequestModel(BaseModel):
2010    rest_api_id: str = Field(alias="restApiId")
2011    request_validator_id: str = Field(alias="requestValidatorId")
2012    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2013        default=None, alias="patchOperations"
2014    )
2015
2016
2017class UpdateResourceRequestModel(BaseModel):
2018    rest_api_id: str = Field(alias="restApiId")
2019    resource_id: str = Field(alias="resourceId")
2020    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2021        default=None, alias="patchOperations"
2022    )
2023
2024
2025class UpdateRestApiRequestModel(BaseModel):
2026    rest_api_id: str = Field(alias="restApiId")
2027    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2028        default=None, alias="patchOperations"
2029    )
2030
2031
2032class UpdateStageRequestModel(BaseModel):
2033    rest_api_id: str = Field(alias="restApiId")
2034    stage_name: str = Field(alias="stageName")
2035    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2036        default=None, alias="patchOperations"
2037    )
2038
2039
2040class UpdateUsagePlanRequestModel(BaseModel):
2041    usage_plan_id: str = Field(alias="usagePlanId")
2042    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2043        default=None, alias="patchOperations"
2044    )
2045
2046
2047class UpdateUsageRequestModel(BaseModel):
2048    usage_plan_id: str = Field(alias="usagePlanId")
2049    key_id: str = Field(alias="keyId")
2050    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2051        default=None, alias="patchOperations"
2052    )
2053
2054
2055class UpdateVpcLinkRequestModel(BaseModel):
2056    vpc_link_id: str = Field(alias="vpcLinkId")
2057    patch_operations: Optional[Sequence[PatchOperationModel]] = Field(
2058        default=None, alias="patchOperations"
2059    )
2060
2061
2062class RequestValidatorsModel(BaseModel):
2063    position: str = Field(alias="position")
2064    items: List[RequestValidatorModel] = Field(alias="items")
2065    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2066
2067
2068class SdkTypeResponseMetadataModel(BaseModel):
2069    id: str = Field(alias="id")
2070    friendly_name: str = Field(alias="friendlyName")
2071    description: str = Field(alias="description")
2072    configuration_properties: List[SdkConfigurationPropertyModel] = Field(
2073        alias="configurationProperties"
2074    )
2075    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2076
2077
2078class SdkTypeModel(BaseModel):
2079    id: Optional[str] = Field(default=None, alias="id")
2080    friendly_name: Optional[str] = Field(default=None, alias="friendlyName")
2081    description: Optional[str] = Field(default=None, alias="description")
2082    configuration_properties: Optional[List[SdkConfigurationPropertyModel]] = Field(
2083        default=None, alias="configurationProperties"
2084    )
2085
2086
2087class UsagePlanKeysModel(BaseModel):
2088    position: str = Field(alias="position")
2089    items: List[UsagePlanKeyModel] = Field(alias="items")
2090    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2091
2092
2093class VpcLinksModel(BaseModel):
2094    position: str = Field(alias="position")
2095    items: List[VpcLinkModel] = Field(alias="items")
2096    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2097
2098
2099class CreateUsagePlanRequestModel(BaseModel):
2100    name: str = Field(alias="name")
2101    description: Optional[str] = Field(default=None, alias="description")
2102    api_stages: Optional[Sequence[ApiStageModel]] = Field(
2103        default=None, alias="apiStages"
2104    )
2105    throttle: Optional[ThrottleSettingsModel] = Field(default=None, alias="throttle")
2106    quota: Optional[QuotaSettingsModel] = Field(default=None, alias="quota")
2107    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
2108
2109
2110class UsagePlanResponseMetadataModel(BaseModel):
2111    id: str = Field(alias="id")
2112    name: str = Field(alias="name")
2113    description: str = Field(alias="description")
2114    api_stages: List[ApiStageModel] = Field(alias="apiStages")
2115    throttle: ThrottleSettingsModel = Field(alias="throttle")
2116    quota: QuotaSettingsModel = Field(alias="quota")
2117    product_code: str = Field(alias="productCode")
2118    tags: Dict[str, str] = Field(alias="tags")
2119    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2120
2121
2122class UsagePlanModel(BaseModel):
2123    id: Optional[str] = Field(default=None, alias="id")
2124    name: Optional[str] = Field(default=None, alias="name")
2125    description: Optional[str] = Field(default=None, alias="description")
2126    api_stages: Optional[List[ApiStageModel]] = Field(default=None, alias="apiStages")
2127    throttle: Optional[ThrottleSettingsModel] = Field(default=None, alias="throttle")
2128    quota: Optional[QuotaSettingsModel] = Field(default=None, alias="quota")
2129    product_code: Optional[str] = Field(default=None, alias="productCode")
2130    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
2131
2132
2133class DocumentationPartsModel(BaseModel):
2134    position: str = Field(alias="position")
2135    items: List[DocumentationPartModel] = Field(alias="items")
2136    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2137
2138
2139class RestApisModel(BaseModel):
2140    position: str = Field(alias="position")
2141    items: List[RestApiModel] = Field(alias="items")
2142    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2143
2144
2145class DeploymentsModel(BaseModel):
2146    position: str = Field(alias="position")
2147    items: List[DeploymentModel] = Field(alias="items")
2148    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2149
2150
2151class DomainNamesModel(BaseModel):
2152    position: str = Field(alias="position")
2153    items: List[DomainNameModel] = Field(alias="items")
2154    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2155
2156
2157class MethodResponseMetadataModel(BaseModel):
2158    http_method: str = Field(alias="httpMethod")
2159    authorization_type: str = Field(alias="authorizationType")
2160    authorizer_id: str = Field(alias="authorizerId")
2161    api_key_required: bool = Field(alias="apiKeyRequired")
2162    request_validator_id: str = Field(alias="requestValidatorId")
2163    operation_name: str = Field(alias="operationName")
2164    request_parameters: Dict[str, bool] = Field(alias="requestParameters")
2165    request_models: Dict[str, str] = Field(alias="requestModels")
2166    method_responses: Dict[str, MethodResponseModel] = Field(alias="methodResponses")
2167    method_integration: IntegrationModel = Field(alias="methodIntegration")
2168    authorization_scopes: List[str] = Field(alias="authorizationScopes")
2169    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2170
2171
2172class MethodModel(BaseModel):
2173    http_method: Optional[str] = Field(default=None, alias="httpMethod")
2174    authorization_type: Optional[str] = Field(default=None, alias="authorizationType")
2175    authorizer_id: Optional[str] = Field(default=None, alias="authorizerId")
2176    api_key_required: Optional[bool] = Field(default=None, alias="apiKeyRequired")
2177    request_validator_id: Optional[str] = Field(
2178        default=None, alias="requestValidatorId"
2179    )
2180    operation_name: Optional[str] = Field(default=None, alias="operationName")
2181    request_parameters: Optional[Dict[str, bool]] = Field(
2182        default=None, alias="requestParameters"
2183    )
2184    request_models: Optional[Dict[str, str]] = Field(
2185        default=None, alias="requestModels"
2186    )
2187    method_responses: Optional[Dict[str, MethodResponseModel]] = Field(
2188        default=None, alias="methodResponses"
2189    )
2190    method_integration: Optional[IntegrationModel] = Field(
2191        default=None, alias="methodIntegration"
2192    )
2193    authorization_scopes: Optional[List[str]] = Field(
2194        default=None, alias="authorizationScopes"
2195    )
2196
2197
2198class StagesModel(BaseModel):
2199    item: List[StageModel] = Field(alias="item")
2200    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2201
2202
2203class SdkTypesModel(BaseModel):
2204    position: str = Field(alias="position")
2205    items: List[SdkTypeModel] = Field(alias="items")
2206    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2207
2208
2209class UsagePlansModel(BaseModel):
2210    position: str = Field(alias="position")
2211    items: List[UsagePlanModel] = Field(alias="items")
2212    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2213
2214
2215class ResourceResponseMetadataModel(BaseModel):
2216    id: str = Field(alias="id")
2217    parent_id: str = Field(alias="parentId")
2218    path_part: str = Field(alias="pathPart")
2219    path: str = Field(alias="path")
2220    resource_methods: Dict[str, MethodModel] = Field(alias="resourceMethods")
2221    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
2222
2223
2224class ResourceModel(BaseModel):
2225    id: Optional[str] = Field(default=None, alias="id")
2226    parent_id: Optional[str] = Field(default=None, alias="parentId")
2227    path_part: Optional[str] = Field(default=None, alias="pathPart")
2228    path: Optional[str] = Field(default=None, alias="path")
2229    resource_methods: Optional[Dict[str, MethodModel]] = Field(
2230        default=None, alias="resourceMethods"
2231    )
2232
2233
2234class ResourcesModel(BaseModel):
2235    position: str = Field(alias="position")
2236    items: List[ResourceModel] = Field(alias="items")
2237    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")