mypydantic.models.acm

  1# Model Generated: Thu Mar  2 21:56:16 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Any, Dict, IO, List, Literal, Optional, Sequence, Type, Union
  7
  8from botocore.response import StreamingBody
  9from pydantic import Field
 10
 11from mypydantic.models.base_model import BaseModel
 12
 13
 14class TagModel(BaseModel):
 15    key: str = Field(alias="Key")
 16    value: Optional[str] = Field(default=None, alias="Value")
 17
 18
 19class CertificateOptionsModel(BaseModel):
 20    certificate_transparency_logging_preference: Optional[
 21        Literal["DISABLED", "ENABLED"]
 22    ] = Field(default=None, alias="CertificateTransparencyLoggingPreference")
 23
 24
 25class ExtendedKeyUsageModel(BaseModel):
 26    name: Optional[
 27        Literal[
 28            "ANY",
 29            "CODE_SIGNING",
 30            "CUSTOM",
 31            "EMAIL_PROTECTION",
 32            "IPSEC_END_SYSTEM",
 33            "IPSEC_TUNNEL",
 34            "IPSEC_USER",
 35            "NONE",
 36            "OCSP_SIGNING",
 37            "TIME_STAMPING",
 38            "TLS_WEB_CLIENT_AUTHENTICATION",
 39            "TLS_WEB_SERVER_AUTHENTICATION",
 40        ]
 41    ] = Field(default=None, alias="Name")
 42    oid: Optional[str] = Field(default=None, alias="OID")
 43
 44
 45class KeyUsageModel(BaseModel):
 46    name: Optional[
 47        Literal[
 48            "ANY",
 49            "CERTIFICATE_SIGNING",
 50            "CRL_SIGNING",
 51            "CUSTOM",
 52            "DATA_ENCIPHERMENT",
 53            "DECIPHER_ONLY",
 54            "DIGITAL_SIGNATURE",
 55            "ENCIPHER_ONLY",
 56            "KEY_AGREEMENT",
 57            "KEY_ENCIPHERMENT",
 58            "NON_REPUDIATION",
 59        ]
 60    ] = Field(default=None, alias="Name")
 61
 62
 63class CertificateSummaryModel(BaseModel):
 64    certificate_arn: Optional[str] = Field(default=None, alias="CertificateArn")
 65    domain_name: Optional[str] = Field(default=None, alias="DomainName")
 66    subject_alternative_name_summaries: Optional[List[str]] = Field(
 67        default=None, alias="SubjectAlternativeNameSummaries"
 68    )
 69    has_additional_subject_alternative_names: Optional[bool] = Field(
 70        default=None, alias="HasAdditionalSubjectAlternativeNames"
 71    )
 72    status: Optional[
 73        Literal[
 74            "EXPIRED",
 75            "FAILED",
 76            "INACTIVE",
 77            "ISSUED",
 78            "PENDING_VALIDATION",
 79            "REVOKED",
 80            "VALIDATION_TIMED_OUT",
 81        ]
 82    ] = Field(default=None, alias="Status")
 83    type: Optional[Literal["AMAZON_ISSUED", "IMPORTED", "PRIVATE"]] = Field(
 84        default=None, alias="Type"
 85    )
 86    key_algorithm: Optional[
 87        Literal[
 88            "EC_prime256v1",
 89            "EC_secp384r1",
 90            "EC_secp521r1",
 91            "RSA_1024",
 92            "RSA_2048",
 93            "RSA_3072",
 94            "RSA_4096",
 95        ]
 96    ] = Field(default=None, alias="KeyAlgorithm")
 97    key_usages: Optional[
 98        List[
 99            Literal[
100                "ANY",
101                "CERTIFICATE_SIGNING",
102                "CRL_SIGNING",
103                "CUSTOM",
104                "DATA_ENCIPHERMENT",
105                "DECIPHER_ONLY",
106                "DIGITAL_SIGNATURE",
107                "ENCIPHER_ONLY",
108                "KEY_AGREEMENT",
109                "KEY_ENCIPHERMENT",
110                "NON_REPUDIATION",
111            ]
112        ]
113    ] = Field(default=None, alias="KeyUsages")
114    extended_key_usages: Optional[
115        List[
116            Literal[
117                "ANY",
118                "CODE_SIGNING",
119                "CUSTOM",
120                "EMAIL_PROTECTION",
121                "IPSEC_END_SYSTEM",
122                "IPSEC_TUNNEL",
123                "IPSEC_USER",
124                "NONE",
125                "OCSP_SIGNING",
126                "TIME_STAMPING",
127                "TLS_WEB_CLIENT_AUTHENTICATION",
128                "TLS_WEB_SERVER_AUTHENTICATION",
129            ]
130        ]
131    ] = Field(default=None, alias="ExtendedKeyUsages")
132    in_use: Optional[bool] = Field(default=None, alias="InUse")
133    exported: Optional[bool] = Field(default=None, alias="Exported")
134    renewal_eligibility: Optional[Literal["ELIGIBLE", "INELIGIBLE"]] = Field(
135        default=None, alias="RenewalEligibility"
136    )
137    not_before: Optional[datetime] = Field(default=None, alias="NotBefore")
138    not_after: Optional[datetime] = Field(default=None, alias="NotAfter")
139    created_at: Optional[datetime] = Field(default=None, alias="CreatedAt")
140    issued_at: Optional[datetime] = Field(default=None, alias="IssuedAt")
141    imported_at: Optional[datetime] = Field(default=None, alias="ImportedAt")
142    revoked_at: Optional[datetime] = Field(default=None, alias="RevokedAt")
143
144
145class DeleteCertificateRequestModel(BaseModel):
146    certificate_arn: str = Field(alias="CertificateArn")
147
148
149class WaiterConfigModel(BaseModel):
150    delay: Optional[int] = Field(default=None, alias="Delay")
151    max_attempts: Optional[int] = Field(default=None, alias="MaxAttempts")
152
153
154class DescribeCertificateRequestModel(BaseModel):
155    certificate_arn: str = Field(alias="CertificateArn")
156
157
158class ResponseMetadataModel(BaseModel):
159    request_id: str = Field(alias="RequestId")
160    host_id: str = Field(alias="HostId")
161    http_status_code: int = Field(alias="HTTPStatusCode")
162    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
163    retry_attempts: int = Field(alias="RetryAttempts")
164
165
166class DomainValidationOptionModel(BaseModel):
167    domain_name: str = Field(alias="DomainName")
168    validation_domain: str = Field(alias="ValidationDomain")
169
170
171class ResourceRecordModel(BaseModel):
172    name: str = Field(alias="Name")
173    type: Literal["CNAME"] = Field(alias="Type")
174    value: str = Field(alias="Value")
175
176
177class ExpiryEventsConfigurationModel(BaseModel):
178    days_before_expiry: Optional[int] = Field(default=None, alias="DaysBeforeExpiry")
179
180
181class ExportCertificateRequestModel(BaseModel):
182    certificate_arn: str = Field(alias="CertificateArn")
183    passphrase: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
184        alias="Passphrase"
185    )
186
187
188class FiltersModel(BaseModel):
189    extended_key_usage: Optional[
190        Sequence[
191            Literal[
192                "ANY",
193                "CODE_SIGNING",
194                "CUSTOM",
195                "EMAIL_PROTECTION",
196                "IPSEC_END_SYSTEM",
197                "IPSEC_TUNNEL",
198                "IPSEC_USER",
199                "NONE",
200                "OCSP_SIGNING",
201                "TIME_STAMPING",
202                "TLS_WEB_CLIENT_AUTHENTICATION",
203                "TLS_WEB_SERVER_AUTHENTICATION",
204            ]
205        ]
206    ] = Field(default=None, alias="extendedKeyUsage")
207    key_usage: Optional[
208        Sequence[
209            Literal[
210                "ANY",
211                "CERTIFICATE_SIGNING",
212                "CRL_SIGNING",
213                "CUSTOM",
214                "DATA_ENCIPHERMENT",
215                "DECIPHER_ONLY",
216                "DIGITAL_SIGNATURE",
217                "ENCIPHER_ONLY",
218                "KEY_AGREEMENT",
219                "KEY_ENCIPHERMENT",
220                "NON_REPUDIATION",
221            ]
222        ]
223    ] = Field(default=None, alias="keyUsage")
224    key_types: Optional[
225        Sequence[
226            Literal[
227                "EC_prime256v1",
228                "EC_secp384r1",
229                "EC_secp521r1",
230                "RSA_1024",
231                "RSA_2048",
232                "RSA_3072",
233                "RSA_4096",
234            ]
235        ]
236    ] = Field(default=None, alias="keyTypes")
237
238
239class GetCertificateRequestModel(BaseModel):
240    certificate_arn: str = Field(alias="CertificateArn")
241
242
243class PaginatorConfigModel(BaseModel):
244    max_items: Optional[int] = Field(default=None, alias="MaxItems")
245    page_size: Optional[int] = Field(default=None, alias="PageSize")
246    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
247
248
249class ListTagsForCertificateRequestModel(BaseModel):
250    certificate_arn: str = Field(alias="CertificateArn")
251
252
253class RenewCertificateRequestModel(BaseModel):
254    certificate_arn: str = Field(alias="CertificateArn")
255
256
257class ResendValidationEmailRequestModel(BaseModel):
258    certificate_arn: str = Field(alias="CertificateArn")
259    domain: str = Field(alias="Domain")
260    validation_domain: str = Field(alias="ValidationDomain")
261
262
263class AddTagsToCertificateRequestModel(BaseModel):
264    certificate_arn: str = Field(alias="CertificateArn")
265    tags: Sequence[TagModel] = Field(alias="Tags")
266
267
268class ImportCertificateRequestModel(BaseModel):
269    certificate: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
270        alias="Certificate"
271    )
272    private_key: Union[str, bytes, Type[IO[Any]], Type[StreamingBody]] = Field(
273        alias="PrivateKey"
274    )
275    certificate_arn: Optional[str] = Field(default=None, alias="CertificateArn")
276    certificate_chain: Optional[
277        Union[str, bytes, Type[IO[Any]], Type[StreamingBody]]
278    ] = Field(default=None, alias="CertificateChain")
279    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
280
281
282class RemoveTagsFromCertificateRequestModel(BaseModel):
283    certificate_arn: str = Field(alias="CertificateArn")
284    tags: Sequence[TagModel] = Field(alias="Tags")
285
286
287class UpdateCertificateOptionsRequestModel(BaseModel):
288    certificate_arn: str = Field(alias="CertificateArn")
289    options: CertificateOptionsModel = Field(alias="Options")
290
291
292class DescribeCertificateRequestCertificateValidatedWaitModel(BaseModel):
293    certificate_arn: str = Field(alias="CertificateArn")
294    waiter_config: Optional[WaiterConfigModel] = Field(
295        default=None, alias="WaiterConfig"
296    )
297
298
299class EmptyResponseMetadataModel(BaseModel):
300    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
301
302
303class ExportCertificateResponseModel(BaseModel):
304    certificate: str = Field(alias="Certificate")
305    certificate_chain: str = Field(alias="CertificateChain")
306    private_key: str = Field(alias="PrivateKey")
307    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
308
309
310class GetCertificateResponseModel(BaseModel):
311    certificate: str = Field(alias="Certificate")
312    certificate_chain: str = Field(alias="CertificateChain")
313    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
314
315
316class ImportCertificateResponseModel(BaseModel):
317    certificate_arn: str = Field(alias="CertificateArn")
318    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
319
320
321class ListCertificatesResponseModel(BaseModel):
322    next_token: str = Field(alias="NextToken")
323    certificate_summary_list: List[CertificateSummaryModel] = Field(
324        alias="CertificateSummaryList"
325    )
326    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
327
328
329class ListTagsForCertificateResponseModel(BaseModel):
330    tags: List[TagModel] = Field(alias="Tags")
331    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
332
333
334class RequestCertificateResponseModel(BaseModel):
335    certificate_arn: str = Field(alias="CertificateArn")
336    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
337
338
339class RequestCertificateRequestModel(BaseModel):
340    domain_name: str = Field(alias="DomainName")
341    validation_method: Optional[Literal["DNS", "EMAIL"]] = Field(
342        default=None, alias="ValidationMethod"
343    )
344    subject_alternative_names: Optional[Sequence[str]] = Field(
345        default=None, alias="SubjectAlternativeNames"
346    )
347    idempotency_token: Optional[str] = Field(default=None, alias="IdempotencyToken")
348    domain_validation_options: Optional[Sequence[DomainValidationOptionModel]] = Field(
349        default=None, alias="DomainValidationOptions"
350    )
351    options: Optional[CertificateOptionsModel] = Field(default=None, alias="Options")
352    certificate_authority_arn: Optional[str] = Field(
353        default=None, alias="CertificateAuthorityArn"
354    )
355    tags: Optional[Sequence[TagModel]] = Field(default=None, alias="Tags")
356    key_algorithm: Optional[
357        Literal[
358            "EC_prime256v1",
359            "EC_secp384r1",
360            "EC_secp521r1",
361            "RSA_1024",
362            "RSA_2048",
363            "RSA_3072",
364            "RSA_4096",
365        ]
366    ] = Field(default=None, alias="KeyAlgorithm")
367
368
369class DomainValidationModel(BaseModel):
370    domain_name: str = Field(alias="DomainName")
371    validation_emails: Optional[List[str]] = Field(
372        default=None, alias="ValidationEmails"
373    )
374    validation_domain: Optional[str] = Field(default=None, alias="ValidationDomain")
375    validation_status: Optional[
376        Literal["FAILED", "PENDING_VALIDATION", "SUCCESS"]
377    ] = Field(default=None, alias="ValidationStatus")
378    resource_record: Optional[ResourceRecordModel] = Field(
379        default=None, alias="ResourceRecord"
380    )
381    validation_method: Optional[Literal["DNS", "EMAIL"]] = Field(
382        default=None, alias="ValidationMethod"
383    )
384
385
386class GetAccountConfigurationResponseModel(BaseModel):
387    expiry_events: ExpiryEventsConfigurationModel = Field(alias="ExpiryEvents")
388    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
389
390
391class PutAccountConfigurationRequestModel(BaseModel):
392    idempotency_token: str = Field(alias="IdempotencyToken")
393    expiry_events: Optional[ExpiryEventsConfigurationModel] = Field(
394        default=None, alias="ExpiryEvents"
395    )
396
397
398class ListCertificatesRequestModel(BaseModel):
399    certificate_statuses: Optional[
400        Sequence[
401            Literal[
402                "EXPIRED",
403                "FAILED",
404                "INACTIVE",
405                "ISSUED",
406                "PENDING_VALIDATION",
407                "REVOKED",
408                "VALIDATION_TIMED_OUT",
409            ]
410        ]
411    ] = Field(default=None, alias="CertificateStatuses")
412    includes: Optional[FiltersModel] = Field(default=None, alias="Includes")
413    next_token: Optional[str] = Field(default=None, alias="NextToken")
414    max_items: Optional[int] = Field(default=None, alias="MaxItems")
415    sort_by: Optional[Literal["CREATED_AT"]] = Field(default=None, alias="SortBy")
416    sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field(
417        default=None, alias="SortOrder"
418    )
419
420
421class ListCertificatesRequestListCertificatesPaginateModel(BaseModel):
422    certificate_statuses: Optional[
423        Sequence[
424            Literal[
425                "EXPIRED",
426                "FAILED",
427                "INACTIVE",
428                "ISSUED",
429                "PENDING_VALIDATION",
430                "REVOKED",
431                "VALIDATION_TIMED_OUT",
432            ]
433        ]
434    ] = Field(default=None, alias="CertificateStatuses")
435    includes: Optional[FiltersModel] = Field(default=None, alias="Includes")
436    sort_by: Optional[Literal["CREATED_AT"]] = Field(default=None, alias="SortBy")
437    sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field(
438        default=None, alias="SortOrder"
439    )
440    pagination_config: Optional[PaginatorConfigModel] = Field(
441        default=None, alias="PaginationConfig"
442    )
443
444
445class RenewalSummaryModel(BaseModel):
446    renewal_status: Literal[
447        "FAILED", "PENDING_AUTO_RENEWAL", "PENDING_VALIDATION", "SUCCESS"
448    ] = Field(alias="RenewalStatus")
449    domain_validation_options: List[DomainValidationModel] = Field(
450        alias="DomainValidationOptions"
451    )
452    updated_at: datetime = Field(alias="UpdatedAt")
453    renewal_status_reason: Optional[
454        Literal[
455            "ADDITIONAL_VERIFICATION_REQUIRED",
456            "CAA_ERROR",
457            "DOMAIN_NOT_ALLOWED",
458            "DOMAIN_VALIDATION_DENIED",
459            "INVALID_PUBLIC_DOMAIN",
460            "NO_AVAILABLE_CONTACTS",
461            "OTHER",
462            "PCA_ACCESS_DENIED",
463            "PCA_INVALID_ARGS",
464            "PCA_INVALID_ARN",
465            "PCA_INVALID_DURATION",
466            "PCA_INVALID_STATE",
467            "PCA_LIMIT_EXCEEDED",
468            "PCA_NAME_CONSTRAINTS_VALIDATION",
469            "PCA_REQUEST_FAILED",
470            "PCA_RESOURCE_NOT_FOUND",
471            "SLR_NOT_FOUND",
472        ]
473    ] = Field(default=None, alias="RenewalStatusReason")
474
475
476class CertificateDetailModel(BaseModel):
477    certificate_arn: Optional[str] = Field(default=None, alias="CertificateArn")
478    domain_name: Optional[str] = Field(default=None, alias="DomainName")
479    subject_alternative_names: Optional[List[str]] = Field(
480        default=None, alias="SubjectAlternativeNames"
481    )
482    domain_validation_options: Optional[List[DomainValidationModel]] = Field(
483        default=None, alias="DomainValidationOptions"
484    )
485    serial: Optional[str] = Field(default=None, alias="Serial")
486    subject: Optional[str] = Field(default=None, alias="Subject")
487    issuer: Optional[str] = Field(default=None, alias="Issuer")
488    created_at: Optional[datetime] = Field(default=None, alias="CreatedAt")
489    issued_at: Optional[datetime] = Field(default=None, alias="IssuedAt")
490    imported_at: Optional[datetime] = Field(default=None, alias="ImportedAt")
491    status: Optional[
492        Literal[
493            "EXPIRED",
494            "FAILED",
495            "INACTIVE",
496            "ISSUED",
497            "PENDING_VALIDATION",
498            "REVOKED",
499            "VALIDATION_TIMED_OUT",
500        ]
501    ] = Field(default=None, alias="Status")
502    revoked_at: Optional[datetime] = Field(default=None, alias="RevokedAt")
503    revocation_reason: Optional[
504        Literal[
505            "AFFILIATION_CHANGED",
506            "A_A_COMPROMISE",
507            "CA_COMPROMISE",
508            "CERTIFICATE_HOLD",
509            "CESSATION_OF_OPERATION",
510            "KEY_COMPROMISE",
511            "PRIVILEGE_WITHDRAWN",
512            "REMOVE_FROM_CRL",
513            "SUPERCEDED",
514            "UNSPECIFIED",
515        ]
516    ] = Field(default=None, alias="RevocationReason")
517    not_before: Optional[datetime] = Field(default=None, alias="NotBefore")
518    not_after: Optional[datetime] = Field(default=None, alias="NotAfter")
519    key_algorithm: Optional[
520        Literal[
521            "EC_prime256v1",
522            "EC_secp384r1",
523            "EC_secp521r1",
524            "RSA_1024",
525            "RSA_2048",
526            "RSA_3072",
527            "RSA_4096",
528        ]
529    ] = Field(default=None, alias="KeyAlgorithm")
530    signature_algorithm: Optional[str] = Field(default=None, alias="SignatureAlgorithm")
531    in_use_by: Optional[List[str]] = Field(default=None, alias="InUseBy")
532    failure_reason: Optional[
533        Literal[
534            "ADDITIONAL_VERIFICATION_REQUIRED",
535            "CAA_ERROR",
536            "DOMAIN_NOT_ALLOWED",
537            "DOMAIN_VALIDATION_DENIED",
538            "INVALID_PUBLIC_DOMAIN",
539            "NO_AVAILABLE_CONTACTS",
540            "OTHER",
541            "PCA_ACCESS_DENIED",
542            "PCA_INVALID_ARGS",
543            "PCA_INVALID_ARN",
544            "PCA_INVALID_DURATION",
545            "PCA_INVALID_STATE",
546            "PCA_LIMIT_EXCEEDED",
547            "PCA_NAME_CONSTRAINTS_VALIDATION",
548            "PCA_REQUEST_FAILED",
549            "PCA_RESOURCE_NOT_FOUND",
550            "SLR_NOT_FOUND",
551        ]
552    ] = Field(default=None, alias="FailureReason")
553    type: Optional[Literal["AMAZON_ISSUED", "IMPORTED", "PRIVATE"]] = Field(
554        default=None, alias="Type"
555    )
556    renewal_summary: Optional[RenewalSummaryModel] = Field(
557        default=None, alias="RenewalSummary"
558    )
559    key_usages: Optional[List[KeyUsageModel]] = Field(default=None, alias="KeyUsages")
560    extended_key_usages: Optional[List[ExtendedKeyUsageModel]] = Field(
561        default=None, alias="ExtendedKeyUsages"
562    )
563    certificate_authority_arn: Optional[str] = Field(
564        default=None, alias="CertificateAuthorityArn"
565    )
566    renewal_eligibility: Optional[Literal["ELIGIBLE", "INELIGIBLE"]] = Field(
567        default=None, alias="RenewalEligibility"
568    )
569    options: Optional[CertificateOptionsModel] = Field(default=None, alias="Options")
570
571
572class DescribeCertificateResponseModel(BaseModel):
573    certificate: CertificateDetailModel = Field(alias="Certificate")
574    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")