1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2018-05-10", 5 "endpointPrefix":"pca-connector-ad", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"PcaConnectorAd", 9 "serviceId":"Pca Connector Ad", 10 "signatureVersion":"v4", 11 "signingName":"pca-connector-ad", 12 "uid":"pca-connector-ad-2018-05-10" 13 }, 14 "operations":{ 15 "CreateConnector":{ 16 "name":"CreateConnector", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/connectors", 20 "responseCode":202 21 }, 22 "input":{"shape":"CreateConnectorRequest"}, 23 "output":{"shape":"CreateConnectorResponse"}, 24 "errors":[ 25 {"shape":"AccessDeniedException"}, 26 {"shape":"ValidationException"}, 27 {"shape":"ResourceNotFoundException"}, 28 {"shape":"ThrottlingException"}, 29 {"shape":"ServiceQuotaExceededException"}, 30 {"shape":"InternalServerException"}, 31 {"shape":"ConflictException"} 32 ], 33 "documentation":"<p>Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.</p>" 34 }, 35 "CreateDirectoryRegistration":{ 36 "name":"CreateDirectoryRegistration", 37 "http":{ 38 "method":"POST", 39 "requestUri":"/directoryRegistrations", 40 "responseCode":202 41 }, 42 "input":{"shape":"CreateDirectoryRegistrationRequest"}, 43 "output":{"shape":"CreateDirectoryRegistrationResponse"}, 44 "errors":[ 45 {"shape":"AccessDeniedException"}, 46 {"shape":"ValidationException"}, 47 {"shape":"ResourceNotFoundException"}, 48 {"shape":"ThrottlingException"}, 49 {"shape":"InternalServerException"}, 50 {"shape":"ConflictException"} 51 ], 52 "documentation":"<p>Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory</p>" 53 }, 54 "CreateServicePrincipalName":{ 55 "name":"CreateServicePrincipalName", 56 "http":{ 57 "method":"POST", 58 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}", 59 "responseCode":202 60 }, 61 "input":{"shape":"CreateServicePrincipalNameRequest"}, 62 "errors":[ 63 {"shape":"AccessDeniedException"}, 64 {"shape":"ValidationException"}, 65 {"shape":"ResourceNotFoundException"}, 66 {"shape":"ThrottlingException"}, 67 {"shape":"InternalServerException"}, 68 {"shape":"ConflictException"} 69 ], 70 "documentation":"<p>Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.</p>", 71 "idempotent":true 72 }, 73 "CreateTemplate":{ 74 "name":"CreateTemplate", 75 "http":{ 76 "method":"POST", 77 "requestUri":"/templates", 78 "responseCode":200 79 }, 80 "input":{"shape":"CreateTemplateRequest"}, 81 "output":{"shape":"CreateTemplateResponse"}, 82 "errors":[ 83 {"shape":"AccessDeniedException"}, 84 {"shape":"ValidationException"}, 85 {"shape":"ResourceNotFoundException"}, 86 {"shape":"ThrottlingException"}, 87 {"shape":"ServiceQuotaExceededException"}, 88 {"shape":"InternalServerException"}, 89 {"shape":"ConflictException"} 90 ], 91 "documentation":"<p>Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.</p>" 92 }, 93 "CreateTemplateGroupAccessControlEntry":{ 94 "name":"CreateTemplateGroupAccessControlEntry", 95 "http":{ 96 "method":"POST", 97 "requestUri":"/templates/{TemplateArn}/accessControlEntries", 98 "responseCode":200 99 }, 100 "input":{"shape":"CreateTemplateGroupAccessControlEntryRequest"}, 101 "errors":[ 102 {"shape":"AccessDeniedException"}, 103 {"shape":"ValidationException"}, 104 {"shape":"ResourceNotFoundException"}, 105 {"shape":"ThrottlingException"}, 106 {"shape":"ServiceQuotaExceededException"}, 107 {"shape":"InternalServerException"}, 108 {"shape":"ConflictException"} 109 ], 110 "documentation":"<p>Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).</p>", 111 "idempotent":true 112 }, 113 "DeleteConnector":{ 114 "name":"DeleteConnector", 115 "http":{ 116 "method":"DELETE", 117 "requestUri":"/connectors/{ConnectorArn}", 118 "responseCode":202 119 }, 120 "input":{"shape":"DeleteConnectorRequest"}, 121 "errors":[ 122 {"shape":"AccessDeniedException"}, 123 {"shape":"ValidationException"}, 124 {"shape":"ResourceNotFoundException"}, 125 {"shape":"ThrottlingException"}, 126 {"shape":"InternalServerException"}, 127 {"shape":"ConflictException"} 128 ], 129 "documentation":"<p>Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors\">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors</a> action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration\">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration</a> action.</p>", 130 "idempotent":true 131 }, 132 "DeleteDirectoryRegistration":{ 133 "name":"DeleteDirectoryRegistration", 134 "http":{ 135 "method":"DELETE", 136 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}", 137 "responseCode":202 138 }, 139 "input":{"shape":"DeleteDirectoryRegistrationRequest"}, 140 "errors":[ 141 {"shape":"AccessDeniedException"}, 142 {"shape":"ValidationException"}, 143 {"shape":"ThrottlingException"}, 144 {"shape":"InternalServerException"}, 145 {"shape":"ConflictException"} 146 ], 147 "documentation":"<p>Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory. </p>", 148 "idempotent":true 149 }, 150 "DeleteServicePrincipalName":{ 151 "name":"DeleteServicePrincipalName", 152 "http":{ 153 "method":"DELETE", 154 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}", 155 "responseCode":202 156 }, 157 "input":{"shape":"DeleteServicePrincipalNameRequest"}, 158 "errors":[ 159 {"shape":"AccessDeniedException"}, 160 {"shape":"ValidationException"}, 161 {"shape":"ThrottlingException"}, 162 {"shape":"InternalServerException"}, 163 {"shape":"ConflictException"} 164 ], 165 "documentation":"<p>Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.</p>", 166 "idempotent":true 167 }, 168 "DeleteTemplate":{ 169 "name":"DeleteTemplate", 170 "http":{ 171 "method":"DELETE", 172 "requestUri":"/templates/{TemplateArn}", 173 "responseCode":202 174 }, 175 "input":{"shape":"DeleteTemplateRequest"}, 176 "errors":[ 177 {"shape":"AccessDeniedException"}, 178 {"shape":"ValidationException"}, 179 {"shape":"ResourceNotFoundException"}, 180 {"shape":"ThrottlingException"}, 181 {"shape":"InternalServerException"}, 182 {"shape":"ConflictException"} 183 ], 184 "documentation":"<p>Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.</p>", 185 "idempotent":true 186 }, 187 "DeleteTemplateGroupAccessControlEntry":{ 188 "name":"DeleteTemplateGroupAccessControlEntry", 189 "http":{ 190 "method":"DELETE", 191 "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", 192 "responseCode":200 193 }, 194 "input":{"shape":"DeleteTemplateGroupAccessControlEntryRequest"}, 195 "errors":[ 196 {"shape":"AccessDeniedException"}, 197 {"shape":"ValidationException"}, 198 {"shape":"ResourceNotFoundException"}, 199 {"shape":"ThrottlingException"}, 200 {"shape":"InternalServerException"}, 201 {"shape":"ConflictException"} 202 ], 203 "documentation":"<p>Deletes a group access control entry.</p>", 204 "idempotent":true 205 }, 206 "GetConnector":{ 207 "name":"GetConnector", 208 "http":{ 209 "method":"GET", 210 "requestUri":"/connectors/{ConnectorArn}", 211 "responseCode":200 212 }, 213 "input":{"shape":"GetConnectorRequest"}, 214 "output":{"shape":"GetConnectorResponse"}, 215 "errors":[ 216 {"shape":"AccessDeniedException"}, 217 {"shape":"ValidationException"}, 218 {"shape":"ResourceNotFoundException"}, 219 {"shape":"ThrottlingException"}, 220 {"shape":"InternalServerException"} 221 ], 222 "documentation":"<p>Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name). </p>" 223 }, 224 "GetDirectoryRegistration":{ 225 "name":"GetDirectoryRegistration", 226 "http":{ 227 "method":"GET", 228 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}", 229 "responseCode":200 230 }, 231 "input":{"shape":"GetDirectoryRegistrationRequest"}, 232 "output":{"shape":"GetDirectoryRegistrationResponse"}, 233 "errors":[ 234 {"shape":"AccessDeniedException"}, 235 {"shape":"ValidationException"}, 236 {"shape":"ResourceNotFoundException"}, 237 {"shape":"ThrottlingException"}, 238 {"shape":"InternalServerException"} 239 ], 240 "documentation":"<p>A structure that contains information about your directory registration.</p>" 241 }, 242 "GetServicePrincipalName":{ 243 "name":"GetServicePrincipalName", 244 "http":{ 245 "method":"GET", 246 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}", 247 "responseCode":200 248 }, 249 "input":{"shape":"GetServicePrincipalNameRequest"}, 250 "output":{"shape":"GetServicePrincipalNameResponse"}, 251 "errors":[ 252 {"shape":"AccessDeniedException"}, 253 {"shape":"ValidationException"}, 254 {"shape":"ResourceNotFoundException"}, 255 {"shape":"ThrottlingException"}, 256 {"shape":"InternalServerException"} 257 ], 258 "documentation":"<p>Lists the service principal name that the connector uses to authenticate with Active Directory.</p>" 259 }, 260 "GetTemplate":{ 261 "name":"GetTemplate", 262 "http":{ 263 "method":"GET", 264 "requestUri":"/templates/{TemplateArn}", 265 "responseCode":200 266 }, 267 "input":{"shape":"GetTemplateRequest"}, 268 "output":{"shape":"GetTemplateResponse"}, 269 "errors":[ 270 {"shape":"AccessDeniedException"}, 271 {"shape":"ValidationException"}, 272 {"shape":"ResourceNotFoundException"}, 273 {"shape":"ThrottlingException"}, 274 {"shape":"InternalServerException"} 275 ], 276 "documentation":"<p>Retrieves a certificate template that the connector uses to issue certificates from a private CA.</p>" 277 }, 278 "GetTemplateGroupAccessControlEntry":{ 279 "name":"GetTemplateGroupAccessControlEntry", 280 "http":{ 281 "method":"GET", 282 "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", 283 "responseCode":200 284 }, 285 "input":{"shape":"GetTemplateGroupAccessControlEntryRequest"}, 286 "output":{"shape":"GetTemplateGroupAccessControlEntryResponse"}, 287 "errors":[ 288 {"shape":"AccessDeniedException"}, 289 {"shape":"ValidationException"}, 290 {"shape":"ResourceNotFoundException"}, 291 {"shape":"ThrottlingException"}, 292 {"shape":"InternalServerException"} 293 ], 294 "documentation":"<p>Retrieves the group access control entries for a template.</p>" 295 }, 296 "ListConnectors":{ 297 "name":"ListConnectors", 298 "http":{ 299 "method":"GET", 300 "requestUri":"/connectors", 301 "responseCode":200 302 }, 303 "input":{"shape":"ListConnectorsRequest"}, 304 "output":{"shape":"ListConnectorsResponse"}, 305 "errors":[ 306 {"shape":"AccessDeniedException"}, 307 {"shape":"ValidationException"}, 308 {"shape":"ThrottlingException"}, 309 {"shape":"InternalServerException"} 310 ], 311 "documentation":"<p>Lists the connectors that you created by using the <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector\">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector</a> action.</p>" 312 }, 313 "ListDirectoryRegistrations":{ 314 "name":"ListDirectoryRegistrations", 315 "http":{ 316 "method":"GET", 317 "requestUri":"/directoryRegistrations", 318 "responseCode":200 319 }, 320 "input":{"shape":"ListDirectoryRegistrationsRequest"}, 321 "output":{"shape":"ListDirectoryRegistrationsResponse"}, 322 "errors":[ 323 {"shape":"AccessDeniedException"}, 324 {"shape":"ValidationException"}, 325 {"shape":"ThrottlingException"}, 326 {"shape":"InternalServerException"} 327 ], 328 "documentation":"<p>Lists the directory registrations that you created by using the <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration\">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration</a> action.</p>" 329 }, 330 "ListServicePrincipalNames":{ 331 "name":"ListServicePrincipalNames", 332 "http":{ 333 "method":"GET", 334 "requestUri":"/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames", 335 "responseCode":200 336 }, 337 "input":{"shape":"ListServicePrincipalNamesRequest"}, 338 "output":{"shape":"ListServicePrincipalNamesResponse"}, 339 "errors":[ 340 {"shape":"AccessDeniedException"}, 341 {"shape":"ValidationException"}, 342 {"shape":"ResourceNotFoundException"}, 343 {"shape":"ThrottlingException"}, 344 {"shape":"InternalServerException"} 345 ], 346 "documentation":"<p>Lists the service principal names that the connector uses to authenticate with Active Directory.</p>" 347 }, 348 "ListTagsForResource":{ 349 "name":"ListTagsForResource", 350 "http":{ 351 "method":"GET", 352 "requestUri":"/tags/{ResourceArn}", 353 "responseCode":200 354 }, 355 "input":{"shape":"ListTagsForResourceRequest"}, 356 "output":{"shape":"ListTagsForResourceResponse"}, 357 "errors":[ 358 {"shape":"AccessDeniedException"}, 359 {"shape":"ValidationException"}, 360 {"shape":"ResourceNotFoundException"}, 361 {"shape":"ThrottlingException"}, 362 {"shape":"InternalServerException"} 363 ], 364 "documentation":"<p>Lists the tags, if any, that are associated with your resource. </p>" 365 }, 366 "ListTemplateGroupAccessControlEntries":{ 367 "name":"ListTemplateGroupAccessControlEntries", 368 "http":{ 369 "method":"GET", 370 "requestUri":"/templates/{TemplateArn}/accessControlEntries", 371 "responseCode":200 372 }, 373 "input":{"shape":"ListTemplateGroupAccessControlEntriesRequest"}, 374 "output":{"shape":"ListTemplateGroupAccessControlEntriesResponse"}, 375 "errors":[ 376 {"shape":"AccessDeniedException"}, 377 {"shape":"ValidationException"}, 378 {"shape":"ResourceNotFoundException"}, 379 {"shape":"ThrottlingException"}, 380 {"shape":"InternalServerException"} 381 ], 382 "documentation":"<p>Lists group access control entries you created. </p>" 383 }, 384 "ListTemplates":{ 385 "name":"ListTemplates", 386 "http":{ 387 "method":"GET", 388 "requestUri":"/templates", 389 "responseCode":200 390 }, 391 "input":{"shape":"ListTemplatesRequest"}, 392 "output":{"shape":"ListTemplatesResponse"}, 393 "errors":[ 394 {"shape":"AccessDeniedException"}, 395 {"shape":"ValidationException"}, 396 {"shape":"ResourceNotFoundException"}, 397 {"shape":"ThrottlingException"}, 398 {"shape":"InternalServerException"} 399 ], 400 "documentation":"<p>Lists the templates, if any, that are associated with a connector.</p>" 401 }, 402 "TagResource":{ 403 "name":"TagResource", 404 "http":{ 405 "method":"POST", 406 "requestUri":"/tags/{ResourceArn}", 407 "responseCode":204 408 }, 409 "input":{"shape":"TagResourceRequest"}, 410 "errors":[ 411 {"shape":"AccessDeniedException"}, 412 {"shape":"ValidationException"}, 413 {"shape":"ResourceNotFoundException"}, 414 {"shape":"ThrottlingException"}, 415 {"shape":"InternalServerException"} 416 ], 417 "documentation":"<p>Adds one or more tags to your resource.</p>" 418 }, 419 "UntagResource":{ 420 "name":"UntagResource", 421 "http":{ 422 "method":"DELETE", 423 "requestUri":"/tags/{ResourceArn}", 424 "responseCode":204 425 }, 426 "input":{"shape":"UntagResourceRequest"}, 427 "errors":[ 428 {"shape":"AccessDeniedException"}, 429 {"shape":"ValidationException"}, 430 {"shape":"ResourceNotFoundException"}, 431 {"shape":"ThrottlingException"}, 432 {"shape":"InternalServerException"} 433 ], 434 "documentation":"<p>Removes one or more tags from your resource.</p>", 435 "idempotent":true 436 }, 437 "UpdateTemplate":{ 438 "name":"UpdateTemplate", 439 "http":{ 440 "method":"PATCH", 441 "requestUri":"/templates/{TemplateArn}", 442 "responseCode":200 443 }, 444 "input":{"shape":"UpdateTemplateRequest"}, 445 "errors":[ 446 {"shape":"AccessDeniedException"}, 447 {"shape":"ValidationException"}, 448 {"shape":"ResourceNotFoundException"}, 449 {"shape":"ThrottlingException"}, 450 {"shape":"InternalServerException"}, 451 {"shape":"ConflictException"} 452 ], 453 "documentation":"<p>Update template configuration to define the information included in certificates.</p>" 454 }, 455 "UpdateTemplateGroupAccessControlEntry":{ 456 "name":"UpdateTemplateGroupAccessControlEntry", 457 "http":{ 458 "method":"PATCH", 459 "requestUri":"/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}", 460 "responseCode":200 461 }, 462 "input":{"shape":"UpdateTemplateGroupAccessControlEntryRequest"}, 463 "errors":[ 464 {"shape":"AccessDeniedException"}, 465 {"shape":"ValidationException"}, 466 {"shape":"ResourceNotFoundException"}, 467 {"shape":"ThrottlingException"}, 468 {"shape":"InternalServerException"}, 469 {"shape":"ConflictException"} 470 ], 471 "documentation":"<p>Update a group access control entry you created using <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplateGroupAccessControlEntry.html\">CreateTemplateGroupAccessControlEntry</a>. </p>" 472 } 473 }, 474 "shapes":{ 475 "AccessControlEntry":{ 476 "type":"structure", 477 "members":{ 478 "AccessRights":{ 479 "shape":"AccessRights", 480 "documentation":"<p>Permissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued against a template.</p>" 481 }, 482 "CreatedAt":{ 483 "shape":"Timestamp", 484 "documentation":"<p>The date and time that the Access Control Entry was created.</p>" 485 }, 486 "GroupDisplayName":{ 487 "shape":"DisplayName", 488 "documentation":"<p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>" 489 }, 490 "GroupSecurityIdentifier":{ 491 "shape":"GroupSecurityIdentifier", 492 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>" 493 }, 494 "TemplateArn":{ 495 "shape":"TemplateArn", 496 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>" 497 }, 498 "UpdatedAt":{ 499 "shape":"Timestamp", 500 "documentation":"<p>The date and time that the Access Control Entry was updated.</p>" 501 } 502 }, 503 "documentation":"<p> An access control entry allows or denies Active Directory groups based on their security identifiers (SIDs) from enrolling and/or autoenrolling with the template.</p>" 504 }, 505 "AccessControlEntryList":{ 506 "type":"list", 507 "member":{"shape":"AccessControlEntrySummary"} 508 }, 509 "AccessControlEntrySummary":{ 510 "type":"structure", 511 "members":{ 512 "AccessRights":{ 513 "shape":"AccessRights", 514 "documentation":"<p>Allow or deny an Active Directory group from enrolling and autoenrolling certificates issued against a template.</p>" 515 }, 516 "CreatedAt":{ 517 "shape":"Timestamp", 518 "documentation":"<p>The date and time that the Access Control Entry was created.</p>" 519 }, 520 "GroupDisplayName":{ 521 "shape":"DisplayName", 522 "documentation":"<p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>" 523 }, 524 "GroupSecurityIdentifier":{ 525 "shape":"GroupSecurityIdentifier", 526 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>" 527 }, 528 "TemplateArn":{ 529 "shape":"TemplateArn", 530 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>. </p>" 531 }, 532 "UpdatedAt":{ 533 "shape":"Timestamp", 534 "documentation":"<p>The date and time that the Access Control Entry was updated.</p>" 535 } 536 }, 537 "documentation":"<p>Summary of group access control entries that allow or deny Active Directory groups based on their security identifiers (SIDs) from enrolling and/or autofenrolling with the template.</p>" 538 }, 539 "AccessDeniedException":{ 540 "type":"structure", 541 "required":["Message"], 542 "members":{ 543 "Message":{"shape":"String"} 544 }, 545 "documentation":"<p>You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account. </p>", 546 "error":{ 547 "httpStatusCode":403, 548 "senderFault":true 549 }, 550 "exception":true 551 }, 552 "AccessRight":{ 553 "type":"string", 554 "enum":[ 555 "ALLOW", 556 "DENY" 557 ] 558 }, 559 "AccessRights":{ 560 "type":"structure", 561 "members":{ 562 "AutoEnroll":{ 563 "shape":"AccessRight", 564 "documentation":"<p>Allow or deny an Active Directory group from autoenrolling certificates issued against a template. The Active Directory group must be allowed to enroll to allow autoenrollment</p>" 565 }, 566 "Enroll":{ 567 "shape":"AccessRight", 568 "documentation":"<p>Allow or deny an Active Directory group from enrolling certificates issued against a template.</p>" 569 } 570 }, 571 "documentation":"<p> Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.</p>" 572 }, 573 "ApplicationPolicies":{ 574 "type":"structure", 575 "required":["Policies"], 576 "members":{ 577 "Critical":{ 578 "shape":"Boolean", 579 "documentation":"<p>Marks the application policy extension as critical.</p>" 580 }, 581 "Policies":{ 582 "shape":"ApplicationPolicyList", 583 "documentation":"<p>Application policies describe what the certificate can be used for.</p>" 584 } 585 }, 586 "documentation":"<p>Application policies describe what the certificate can be used for.</p>" 587 }, 588 "ApplicationPolicy":{ 589 "type":"structure", 590 "members":{ 591 "PolicyObjectIdentifier":{ 592 "shape":"CustomObjectIdentifier", 593 "documentation":"<p>The object identifier (OID) of an application policy.</p>" 594 }, 595 "PolicyType":{ 596 "shape":"ApplicationPolicyType", 597 "documentation":"<p>The type of application policy</p>" 598 } 599 }, 600 "documentation":"<p>Application policies describe what the certificate can be used for.</p>", 601 "union":true 602 }, 603 "ApplicationPolicyList":{ 604 "type":"list", 605 "member":{"shape":"ApplicationPolicy"}, 606 "max":100, 607 "min":1 608 }, 609 "ApplicationPolicyType":{ 610 "type":"string", 611 "enum":[ 612 "ALL_APPLICATION_POLICIES", 613 "ANY_PURPOSE", 614 "ATTESTATION_IDENTITY_KEY_CERTIFICATE", 615 "CERTIFICATE_REQUEST_AGENT", 616 "CLIENT_AUTHENTICATION", 617 "CODE_SIGNING", 618 "CTL_USAGE", 619 "DIGITAL_RIGHTS", 620 "DIRECTORY_SERVICE_EMAIL_REPLICATION", 621 "DISALLOWED_LIST", 622 "DNS_SERVER_TRUST", 623 "DOCUMENT_ENCRYPTION", 624 "DOCUMENT_SIGNING", 625 "DYNAMIC_CODE_GENERATOR", 626 "EARLY_LAUNCH_ANTIMALWARE_DRIVER", 627 "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", 628 "ENCLAVE", 629 "ENCRYPTING_FILE_SYSTEM", 630 "ENDORSEMENT_KEY_CERTIFICATE", 631 "FILE_RECOVERY", 632 "HAL_EXTENSION", 633 "IP_SECURITY_END_SYSTEM", 634 "IP_SECURITY_IKE_INTERMEDIATE", 635 "IP_SECURITY_TUNNEL_TERMINATION", 636 "IP_SECURITY_USER", 637 "ISOLATED_USER_MODE", 638 "KDC_AUTHENTICATION", 639 "KERNEL_MODE_CODE_SIGNING", 640 "KEY_PACK_LICENSES", 641 "KEY_RECOVERY", 642 "KEY_RECOVERY_AGENT", 643 "LICENSE_SERVER_VERIFICATION", 644 "LIFETIME_SIGNING", 645 "MICROSOFT_PUBLISHER", 646 "MICROSOFT_TIME_STAMPING", 647 "MICROSOFT_TRUST_LIST_SIGNING", 648 "OCSP_SIGNING", 649 "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION", 650 "PLATFORM_CERTIFICATE", 651 "PREVIEW_BUILD_SIGNING", 652 "PRIVATE_KEY_ARCHIVAL", 653 "PROTECTED_PROCESS_LIGHT_VERIFICATION", 654 "PROTECTED_PROCESS_VERIFICATION", 655 "QUALIFIED_SUBORDINATION", 656 "REVOKED_LIST_SIGNER", 657 "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION", 658 "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION", 659 "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL", 660 "ROOT_LIST_SIGNER", 661 "SECURE_EMAIL", 662 "SERVER_AUTHENTICATION", 663 "SMART_CARD_LOGIN", 664 "SPC_ENCRYPTED_DIGEST_RETRY_COUNT", 665 "SPC_RELAXED_PE_MARKER_CHECK", 666 "TIME_STAMPING", 667 "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION", 668 "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION", 669 "WINDOWS_HARDWARE_DRIVER_VERIFICATION", 670 "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION", 671 "WINDOWS_KITS_COMPONENT", 672 "WINDOWS_RT_VERIFICATION", 673 "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION", 674 "WINDOWS_STORE", 675 "WINDOWS_SYSTEM_COMPONENT_VERIFICATION", 676 "WINDOWS_TCB_COMPONENT", 677 "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT", 678 "WINDOWS_UPDATE" 679 ] 680 }, 681 "Boolean":{ 682 "type":"boolean", 683 "box":true 684 }, 685 "CertificateAuthorityArn":{ 686 "type":"string", 687 "max":200, 688 "min":5, 689 "pattern":"^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" 690 }, 691 "CertificateValidity":{ 692 "type":"structure", 693 "required":[ 694 "RenewalPeriod", 695 "ValidityPeriod" 696 ], 697 "members":{ 698 "RenewalPeriod":{ 699 "shape":"ValidityPeriod", 700 "documentation":"<p>Renewal period is the period of time before certificate expiration when a new certificate will be requested.</p>" 701 }, 702 "ValidityPeriod":{ 703 "shape":"ValidityPeriod", 704 "documentation":"<p>Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.</p>" 705 } 706 }, 707 "documentation":"<p>Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.</p>" 708 }, 709 "ClientCompatibilityV2":{ 710 "type":"string", 711 "enum":[ 712 "WINDOWS_SERVER_2003", 713 "WINDOWS_SERVER_2008", 714 "WINDOWS_SERVER_2008_R2", 715 "WINDOWS_SERVER_2012", 716 "WINDOWS_SERVER_2012_R2", 717 "WINDOWS_SERVER_2016" 718 ] 719 }, 720 "ClientCompatibilityV3":{ 721 "type":"string", 722 "enum":[ 723 "WINDOWS_SERVER_2008", 724 "WINDOWS_SERVER_2008_R2", 725 "WINDOWS_SERVER_2012", 726 "WINDOWS_SERVER_2012_R2", 727 "WINDOWS_SERVER_2016" 728 ] 729 }, 730 "ClientCompatibilityV4":{ 731 "type":"string", 732 "enum":[ 733 "WINDOWS_SERVER_2012", 734 "WINDOWS_SERVER_2012_R2", 735 "WINDOWS_SERVER_2016" 736 ] 737 }, 738 "ClientToken":{ 739 "type":"string", 740 "max":64, 741 "min":1, 742 "pattern":"^[!-~]+$" 743 }, 744 "ConflictException":{ 745 "type":"structure", 746 "required":[ 747 "Message", 748 "ResourceId", 749 "ResourceType" 750 ], 751 "members":{ 752 "Message":{"shape":"String"}, 753 "ResourceId":{ 754 "shape":"String", 755 "documentation":"<p>The identifier of the Amazon Web Services resource.</p>" 756 }, 757 "ResourceType":{ 758 "shape":"String", 759 "documentation":"<p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>" 760 } 761 }, 762 "documentation":"<p>This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.</p>", 763 "error":{ 764 "httpStatusCode":409, 765 "senderFault":true 766 }, 767 "exception":true 768 }, 769 "Connector":{ 770 "type":"structure", 771 "members":{ 772 "Arn":{ 773 "shape":"ConnectorArn", 774 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>. </p>" 775 }, 776 "CertificateAuthorityArn":{ 777 "shape":"CertificateAuthorityArn", 778 "documentation":"<p>The Amazon Resource Name (ARN) of the certificate authority being used. </p>" 779 }, 780 "CertificateEnrollmentPolicyServerEndpoint":{ 781 "shape":"String", 782 "documentation":"<p>Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when requesting certificates.</p>" 783 }, 784 "CreatedAt":{ 785 "shape":"Timestamp", 786 "documentation":"<p>The date and time that the connector was created.</p>" 787 }, 788 "DirectoryId":{ 789 "shape":"DirectoryId", 790 "documentation":"<p>The identifier of the Active Directory.</p>" 791 }, 792 "Status":{ 793 "shape":"ConnectorStatus", 794 "documentation":"<p>Status of the connector. Status can be creating, active, deleting, or failed.</p>" 795 }, 796 "StatusReason":{ 797 "shape":"ConnectorStatusReason", 798 "documentation":"<p>Additional information about the connector status if the status is failed.</p>" 799 }, 800 "UpdatedAt":{ 801 "shape":"Timestamp", 802 "documentation":"<p>The date and time that the connector was updated.</p>" 803 }, 804 "VpcInformation":{ 805 "shape":"VpcInformation", 806 "documentation":"<p>Information of the VPC and security group(s) used with the connector.</p>" 807 } 808 }, 809 "documentation":"<p>Amazon Web Services Private CA Connector for Active Directory is a service that links your Active Directory with Amazon Web Services Private CA. The connector brokers the exchange of certificates from Amazon Web Services Private CA to domain-joined users and machines managed with Active Directory.</p>" 810 }, 811 "ConnectorArn":{ 812 "type":"string", 813 "max":200, 814 "min":5, 815 "pattern":"^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" 816 }, 817 "ConnectorList":{ 818 "type":"list", 819 "member":{"shape":"ConnectorSummary"} 820 }, 821 "ConnectorStatus":{ 822 "type":"string", 823 "enum":[ 824 "CREATING", 825 "ACTIVE", 826 "DELETING", 827 "FAILED" 828 ] 829 }, 830 "ConnectorStatusReason":{ 831 "type":"string", 832 "enum":[ 833 "DIRECTORY_ACCESS_DENIED", 834 "INTERNAL_FAILURE", 835 "PRIVATECA_ACCESS_DENIED", 836 "PRIVATECA_RESOURCE_NOT_FOUND", 837 "SECURITY_GROUP_NOT_IN_VPC", 838 "VPC_ACCESS_DENIED", 839 "VPC_ENDPOINT_LIMIT_EXCEEDED", 840 "VPC_RESOURCE_NOT_FOUND" 841 ] 842 }, 843 "ConnectorSummary":{ 844 "type":"structure", 845 "members":{ 846 "Arn":{ 847 "shape":"ConnectorArn", 848 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>" 849 }, 850 "CertificateAuthorityArn":{ 851 "shape":"CertificateAuthorityArn", 852 "documentation":"<p>The Amazon Resource Name (ARN) of the certificate authority being used.</p>" 853 }, 854 "CertificateEnrollmentPolicyServerEndpoint":{ 855 "shape":"String", 856 "documentation":"<p>Certificate enrollment endpoint for Active Directory domain-joined objects to request certificates.</p>" 857 }, 858 "CreatedAt":{ 859 "shape":"Timestamp", 860 "documentation":"<p>The date and time that the connector was created.</p>" 861 }, 862 "DirectoryId":{ 863 "shape":"DirectoryId", 864 "documentation":"<p>The identifier of the Active Directory.</p>" 865 }, 866 "Status":{ 867 "shape":"ConnectorStatus", 868 "documentation":"<p>Status of the connector. Status can be creating, active, deleting, or failed.</p>" 869 }, 870 "StatusReason":{ 871 "shape":"ConnectorStatusReason", 872 "documentation":"<p>Additional information about the connector status if the status is failed.</p>" 873 }, 874 "UpdatedAt":{ 875 "shape":"Timestamp", 876 "documentation":"<p>The date and time that the connector was updated.</p>" 877 }, 878 "VpcInformation":{ 879 "shape":"VpcInformation", 880 "documentation":"<p>Information of the VPC and security group(s) used with the connector.</p>" 881 } 882 }, 883 "documentation":"<p>Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services account.</p>" 884 }, 885 "CreateConnectorRequest":{ 886 "type":"structure", 887 "required":[ 888 "CertificateAuthorityArn", 889 "DirectoryId", 890 "VpcInformation" 891 ], 892 "members":{ 893 "CertificateAuthorityArn":{ 894 "shape":"CertificateAuthorityArn", 895 "documentation":"<p> The Amazon Resource Name (ARN) of the certificate authority being used.</p>" 896 }, 897 "ClientToken":{ 898 "shape":"ClientToken", 899 "documentation":"<p>Idempotency token.</p>", 900 "idempotencyToken":true 901 }, 902 "DirectoryId":{ 903 "shape":"DirectoryId", 904 "documentation":"<p>The identifier of the Active Directory.</p>" 905 }, 906 "Tags":{ 907 "shape":"Tags", 908 "documentation":"<p>Metadata assigned to a connector consisting of a key-value pair.</p>" 909 }, 910 "VpcInformation":{ 911 "shape":"VpcInformation", 912 "documentation":"<p>Security group IDs that describe the inbound and outbound rules.</p>" 913 } 914 } 915 }, 916 "CreateConnectorResponse":{ 917 "type":"structure", 918 "members":{ 919 "ConnectorArn":{ 920 "shape":"ConnectorArn", 921 "documentation":"<p>If successful, the Amazon Resource Name (ARN) of the connector for Active Directory.</p>" 922 } 923 } 924 }, 925 "CreateDirectoryRegistrationRequest":{ 926 "type":"structure", 927 "required":["DirectoryId"], 928 "members":{ 929 "ClientToken":{ 930 "shape":"ClientToken", 931 "documentation":"<p>Idempotency token.</p>", 932 "idempotencyToken":true 933 }, 934 "DirectoryId":{ 935 "shape":"DirectoryId", 936 "documentation":"<p> The identifier of the Active Directory.</p>" 937 }, 938 "Tags":{ 939 "shape":"Tags", 940 "documentation":"<p>Metadata assigned to a directory registration consisting of a key-value pair.</p>" 941 } 942 } 943 }, 944 "CreateDirectoryRegistrationResponse":{ 945 "type":"structure", 946 "members":{ 947 "DirectoryRegistrationArn":{ 948 "shape":"DirectoryRegistrationArn", 949 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>" 950 } 951 } 952 }, 953 "CreateServicePrincipalNameRequest":{ 954 "type":"structure", 955 "required":[ 956 "ConnectorArn", 957 "DirectoryRegistrationArn" 958 ], 959 "members":{ 960 "ClientToken":{ 961 "shape":"ClientToken", 962 "documentation":"<p>Idempotency token.</p>", 963 "idempotencyToken":true 964 }, 965 "ConnectorArn":{ 966 "shape":"ConnectorArn", 967 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 968 "location":"uri", 969 "locationName":"ConnectorArn" 970 }, 971 "DirectoryRegistrationArn":{ 972 "shape":"DirectoryRegistrationArn", 973 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 974 "location":"uri", 975 "locationName":"DirectoryRegistrationArn" 976 } 977 } 978 }, 979 "CreateTemplateGroupAccessControlEntryRequest":{ 980 "type":"structure", 981 "required":[ 982 "AccessRights", 983 "GroupDisplayName", 984 "GroupSecurityIdentifier", 985 "TemplateArn" 986 ], 987 "members":{ 988 "AccessRights":{ 989 "shape":"AccessRights", 990 "documentation":"<p> Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.</p>" 991 }, 992 "ClientToken":{ 993 "shape":"ClientToken", 994 "documentation":"<p>Idempotency token.</p>", 995 "idempotencyToken":true 996 }, 997 "GroupDisplayName":{ 998 "shape":"DisplayName", 999 "documentation":"<p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>" 1000 }, 1001 "GroupSecurityIdentifier":{ 1002 "shape":"GroupSecurityIdentifier", 1003 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>" 1004 }, 1005 "TemplateArn":{ 1006 "shape":"TemplateArn", 1007 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1008 "location":"uri", 1009 "locationName":"TemplateArn" 1010 } 1011 } 1012 }, 1013 "CreateTemplateRequest":{ 1014 "type":"structure", 1015 "required":[ 1016 "ConnectorArn", 1017 "Definition", 1018 "Name" 1019 ], 1020 "members":{ 1021 "ClientToken":{ 1022 "shape":"ClientToken", 1023 "documentation":"<p>Idempotency token.</p>", 1024 "idempotencyToken":true 1025 }, 1026 "ConnectorArn":{ 1027 "shape":"ConnectorArn", 1028 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>" 1029 }, 1030 "Definition":{ 1031 "shape":"TemplateDefinition", 1032 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 1033 }, 1034 "Name":{ 1035 "shape":"TemplateName", 1036 "documentation":"<p>Name of the template. The template name must be unique.</p>" 1037 }, 1038 "Tags":{ 1039 "shape":"Tags", 1040 "documentation":"<p>Metadata assigned to a template consisting of a key-value pair.</p>" 1041 } 1042 } 1043 }, 1044 "CreateTemplateResponse":{ 1045 "type":"structure", 1046 "members":{ 1047 "TemplateArn":{ 1048 "shape":"TemplateArn", 1049 "documentation":"<p>If successful, the Amazon Resource Name (ARN) of the template.</p>" 1050 } 1051 } 1052 }, 1053 "CryptoProvidersList":{ 1054 "type":"list", 1055 "member":{"shape":"CryptoProvidersListMemberString"}, 1056 "max":100, 1057 "min":1 1058 }, 1059 "CryptoProvidersListMemberString":{ 1060 "type":"string", 1061 "max":100, 1062 "min":1 1063 }, 1064 "CustomObjectIdentifier":{ 1065 "type":"string", 1066 "max":64, 1067 "min":1, 1068 "pattern":"^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$" 1069 }, 1070 "DeleteConnectorRequest":{ 1071 "type":"structure", 1072 "required":["ConnectorArn"], 1073 "members":{ 1074 "ConnectorArn":{ 1075 "shape":"ConnectorArn", 1076 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 1077 "location":"uri", 1078 "locationName":"ConnectorArn" 1079 } 1080 } 1081 }, 1082 "DeleteDirectoryRegistrationRequest":{ 1083 "type":"structure", 1084 "required":["DirectoryRegistrationArn"], 1085 "members":{ 1086 "DirectoryRegistrationArn":{ 1087 "shape":"DirectoryRegistrationArn", 1088 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 1089 "location":"uri", 1090 "locationName":"DirectoryRegistrationArn" 1091 } 1092 } 1093 }, 1094 "DeleteServicePrincipalNameRequest":{ 1095 "type":"structure", 1096 "required":[ 1097 "ConnectorArn", 1098 "DirectoryRegistrationArn" 1099 ], 1100 "members":{ 1101 "ConnectorArn":{ 1102 "shape":"ConnectorArn", 1103 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 1104 "location":"uri", 1105 "locationName":"ConnectorArn" 1106 }, 1107 "DirectoryRegistrationArn":{ 1108 "shape":"DirectoryRegistrationArn", 1109 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 1110 "location":"uri", 1111 "locationName":"DirectoryRegistrationArn" 1112 } 1113 } 1114 }, 1115 "DeleteTemplateGroupAccessControlEntryRequest":{ 1116 "type":"structure", 1117 "required":[ 1118 "GroupSecurityIdentifier", 1119 "TemplateArn" 1120 ], 1121 "members":{ 1122 "GroupSecurityIdentifier":{ 1123 "shape":"GroupSecurityIdentifier", 1124 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>", 1125 "location":"uri", 1126 "locationName":"GroupSecurityIdentifier" 1127 }, 1128 "TemplateArn":{ 1129 "shape":"TemplateArn", 1130 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1131 "location":"uri", 1132 "locationName":"TemplateArn" 1133 } 1134 } 1135 }, 1136 "DeleteTemplateRequest":{ 1137 "type":"structure", 1138 "required":["TemplateArn"], 1139 "members":{ 1140 "TemplateArn":{ 1141 "shape":"TemplateArn", 1142 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1143 "location":"uri", 1144 "locationName":"TemplateArn" 1145 } 1146 } 1147 }, 1148 "DirectoryId":{ 1149 "type":"string", 1150 "pattern":"^d-[0-9a-f]{10}$" 1151 }, 1152 "DirectoryRegistration":{ 1153 "type":"structure", 1154 "members":{ 1155 "Arn":{ 1156 "shape":"DirectoryRegistrationArn", 1157 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration. </p>" 1158 }, 1159 "CreatedAt":{ 1160 "shape":"Timestamp", 1161 "documentation":"<p>The date and time that the directory registration was created.</p>" 1162 }, 1163 "DirectoryId":{ 1164 "shape":"DirectoryId", 1165 "documentation":"<p>The identifier of the Active Directory.</p>" 1166 }, 1167 "Status":{ 1168 "shape":"DirectoryRegistrationStatus", 1169 "documentation":"<p>Status of the directory registration.</p>" 1170 }, 1171 "StatusReason":{ 1172 "shape":"DirectoryRegistrationStatusReason", 1173 "documentation":"<p>Additional information about the directory registration status if the status is failed.</p>" 1174 }, 1175 "UpdatedAt":{ 1176 "shape":"Timestamp", 1177 "documentation":"<p>The date and time that the directory registration was updated.</p>" 1178 } 1179 }, 1180 "documentation":"<p>The directory registration represents the authorization of the connector service with a directory.</p>" 1181 }, 1182 "DirectoryRegistrationArn":{ 1183 "type":"string", 1184 "max":200, 1185 "min":5, 1186 "pattern":"^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration\\/d-[0-9a-f]{10}$" 1187 }, 1188 "DirectoryRegistrationList":{ 1189 "type":"list", 1190 "member":{"shape":"DirectoryRegistrationSummary"} 1191 }, 1192 "DirectoryRegistrationStatus":{ 1193 "type":"string", 1194 "enum":[ 1195 "CREATING", 1196 "ACTIVE", 1197 "DELETING", 1198 "FAILED" 1199 ] 1200 }, 1201 "DirectoryRegistrationStatusReason":{ 1202 "type":"string", 1203 "enum":[ 1204 "DIRECTORY_ACCESS_DENIED", 1205 "DIRECTORY_RESOURCE_NOT_FOUND", 1206 "DIRECTORY_NOT_ACTIVE", 1207 "DIRECTORY_NOT_REACHABLE", 1208 "DIRECTORY_TYPE_NOT_SUPPORTED", 1209 "INTERNAL_FAILURE" 1210 ] 1211 }, 1212 "DirectoryRegistrationSummary":{ 1213 "type":"structure", 1214 "members":{ 1215 "Arn":{ 1216 "shape":"DirectoryRegistrationArn", 1217 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>" 1218 }, 1219 "CreatedAt":{ 1220 "shape":"Timestamp", 1221 "documentation":"<p>The date and time that the directory registration was created.</p>" 1222 }, 1223 "DirectoryId":{ 1224 "shape":"DirectoryId", 1225 "documentation":"<p>The identifier of the Active Directory.</p>" 1226 }, 1227 "Status":{ 1228 "shape":"DirectoryRegistrationStatus", 1229 "documentation":"<p>Status of the directory registration.</p>" 1230 }, 1231 "StatusReason":{ 1232 "shape":"DirectoryRegistrationStatusReason", 1233 "documentation":"<p>Additional information about the directory registration status if the status is failed.</p>" 1234 }, 1235 "UpdatedAt":{ 1236 "shape":"Timestamp", 1237 "documentation":"<p>The date and time that the directory registration was updated.</p>" 1238 } 1239 }, 1240 "documentation":"<p>The directory registration represents the authorization of the connector service with the Active Directory.</p>" 1241 }, 1242 "DisplayName":{ 1243 "type":"string", 1244 "max":256, 1245 "min":0, 1246 "pattern":"^[\\x20-\\x7E]+$" 1247 }, 1248 "EnrollmentFlagsV2":{ 1249 "type":"structure", 1250 "members":{ 1251 "EnableKeyReuseOnNtTokenKeysetStorageFull":{ 1252 "shape":"Boolean", 1253 "documentation":"<p>Allow renewal using the same key.</p>" 1254 }, 1255 "IncludeSymmetricAlgorithms":{ 1256 "shape":"Boolean", 1257 "documentation":"<p>Include symmetric algorithms allowed by the subject.</p>" 1258 }, 1259 "NoSecurityExtension":{ 1260 "shape":"Boolean", 1261 "documentation":"<p>This flag instructs the CA to not include the security extension szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows Kerberos elevation-of-privilege vulnerability.</p>" 1262 }, 1263 "RemoveInvalidCertificateFromPersonalStore":{ 1264 "shape":"Boolean", 1265 "documentation":"<p>Delete expired or revoked certificates instead of archiving them.</p>" 1266 }, 1267 "UserInteractionRequired":{ 1268 "shape":"Boolean", 1269 "documentation":"<p>Require user interaction when the subject is enrolled and the private key associated with the certificate is used.</p>" 1270 } 1271 }, 1272 "documentation":"<p>Template configurations for v2 template schema.</p>" 1273 }, 1274 "EnrollmentFlagsV3":{ 1275 "type":"structure", 1276 "members":{ 1277 "EnableKeyReuseOnNtTokenKeysetStorageFull":{ 1278 "shape":"Boolean", 1279 "documentation":"<p>Allow renewal using the same key.</p>" 1280 }, 1281 "IncludeSymmetricAlgorithms":{ 1282 "shape":"Boolean", 1283 "documentation":"<p>Include symmetric algorithms allowed by the subject.</p>" 1284 }, 1285 "NoSecurityExtension":{ 1286 "shape":"Boolean", 1287 "documentation":"<p>This flag instructs the CA to not include the security extension szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows Kerberos elevation-of-privilege vulnerability.</p>" 1288 }, 1289 "RemoveInvalidCertificateFromPersonalStore":{ 1290 "shape":"Boolean", 1291 "documentation":"<p>Delete expired or revoked certificates instead of archiving them.</p>" 1292 }, 1293 "UserInteractionRequired":{ 1294 "shape":"Boolean", 1295 "documentation":"<p>Require user interaction when the subject is enrolled and the private key associated with the certificate is used.</p>" 1296 } 1297 }, 1298 "documentation":"<p>Template configurations for v3 template schema.</p>" 1299 }, 1300 "EnrollmentFlagsV4":{ 1301 "type":"structure", 1302 "members":{ 1303 "EnableKeyReuseOnNtTokenKeysetStorageFull":{ 1304 "shape":"Boolean", 1305 "documentation":"<p>Allow renewal using the same key.</p>" 1306 }, 1307 "IncludeSymmetricAlgorithms":{ 1308 "shape":"Boolean", 1309 "documentation":"<p>Include symmetric algorithms allowed by the subject.</p>" 1310 }, 1311 "NoSecurityExtension":{ 1312 "shape":"Boolean", 1313 "documentation":"<p>This flag instructs the CA to not include the security extension szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows Kerberos elevation-of-privilege vulnerability.</p>" 1314 }, 1315 "RemoveInvalidCertificateFromPersonalStore":{ 1316 "shape":"Boolean", 1317 "documentation":"<p>Delete expired or revoked certificates instead of archiving them.</p>" 1318 }, 1319 "UserInteractionRequired":{ 1320 "shape":"Boolean", 1321 "documentation":"<p>Require user interaction when the subject is enrolled and the private key associated with the certificate is used.</p>" 1322 } 1323 }, 1324 "documentation":"<p>Template configurations for v4 template schema.</p>" 1325 }, 1326 "ExtensionsV2":{ 1327 "type":"structure", 1328 "required":["KeyUsage"], 1329 "members":{ 1330 "ApplicationPolicies":{ 1331 "shape":"ApplicationPolicies", 1332 "documentation":"<p>Application policies specify what the certificate is used for and its purpose. </p>" 1333 }, 1334 "KeyUsage":{ 1335 "shape":"KeyUsage", 1336 "documentation":"<p>The key usage extension defines the purpose (e.g., encipherment, signature, certificate signing) of the key contained in the certificate.</p>" 1337 } 1338 }, 1339 "documentation":"<p>Certificate extensions for v2 template schema</p>" 1340 }, 1341 "ExtensionsV3":{ 1342 "type":"structure", 1343 "required":["KeyUsage"], 1344 "members":{ 1345 "ApplicationPolicies":{ 1346 "shape":"ApplicationPolicies", 1347 "documentation":"<p>Application policies specify what the certificate is used for and its purpose.</p>" 1348 }, 1349 "KeyUsage":{ 1350 "shape":"KeyUsage", 1351 "documentation":"<p>The key usage extension defines the purpose (e.g., encipherment, signature, certificate signing) of the key contained in the certificate.</p>" 1352 } 1353 }, 1354 "documentation":"<p>Certificate extensions for v3 template schema</p>" 1355 }, 1356 "ExtensionsV4":{ 1357 "type":"structure", 1358 "required":["KeyUsage"], 1359 "members":{ 1360 "ApplicationPolicies":{ 1361 "shape":"ApplicationPolicies", 1362 "documentation":"<p>Application policies specify what the certificate is used for and its purpose.</p>" 1363 }, 1364 "KeyUsage":{ 1365 "shape":"KeyUsage", 1366 "documentation":"<p>The key usage extension defines the purpose (e.g., encipherment, signature) of the key contained in the certificate.</p>" 1367 } 1368 }, 1369 "documentation":"<p>Certificate extensions for v4 template schema</p>" 1370 }, 1371 "GeneralFlagsV2":{ 1372 "type":"structure", 1373 "members":{ 1374 "AutoEnrollment":{ 1375 "shape":"Boolean", 1376 "documentation":"<p>Allows certificate issuance using autoenrollment. Set to TRUE to allow autoenrollment.</p>" 1377 }, 1378 "MachineType":{ 1379 "shape":"Boolean", 1380 "documentation":"<p>Defines if the template is for machines or users. Set to TRUE if the template is for machines. Set to FALSE if the template is for users.</p>" 1381 } 1382 }, 1383 "documentation":"<p>General flags for v2 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.</p>" 1384 }, 1385 "GeneralFlagsV3":{ 1386 "type":"structure", 1387 "members":{ 1388 "AutoEnrollment":{ 1389 "shape":"Boolean", 1390 "documentation":"<p>Allows certificate issuance using autoenrollment. Set to TRUE to allow autoenrollment.</p>" 1391 }, 1392 "MachineType":{ 1393 "shape":"Boolean", 1394 "documentation":"<p>Defines if the template is for machines or users. Set to TRUE if the template is for machines. Set to FALSE if the template is for users</p>" 1395 } 1396 }, 1397 "documentation":"<p>General flags for v3 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.</p>" 1398 }, 1399 "GeneralFlagsV4":{ 1400 "type":"structure", 1401 "members":{ 1402 "AutoEnrollment":{ 1403 "shape":"Boolean", 1404 "documentation":"<p>Allows certificate issuance using autoenrollment. Set to TRUE to allow autoenrollment.</p>" 1405 }, 1406 "MachineType":{ 1407 "shape":"Boolean", 1408 "documentation":"<p>Defines if the template is for machines or users. Set to TRUE if the template is for machines. Set to FALSE if the template is for users</p>" 1409 } 1410 }, 1411 "documentation":"<p>General flags for v4 template schema that defines if the template is for a machine or a user and if the template can be issued using autoenrollment.</p>" 1412 }, 1413 "GetConnectorRequest":{ 1414 "type":"structure", 1415 "required":["ConnectorArn"], 1416 "members":{ 1417 "ConnectorArn":{ 1418 "shape":"ConnectorArn", 1419 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 1420 "location":"uri", 1421 "locationName":"ConnectorArn" 1422 } 1423 } 1424 }, 1425 "GetConnectorResponse":{ 1426 "type":"structure", 1427 "members":{ 1428 "Connector":{ 1429 "shape":"Connector", 1430 "documentation":"<p>A structure that contains information about your connector.</p>" 1431 } 1432 } 1433 }, 1434 "GetDirectoryRegistrationRequest":{ 1435 "type":"structure", 1436 "required":["DirectoryRegistrationArn"], 1437 "members":{ 1438 "DirectoryRegistrationArn":{ 1439 "shape":"DirectoryRegistrationArn", 1440 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 1441 "location":"uri", 1442 "locationName":"DirectoryRegistrationArn" 1443 } 1444 } 1445 }, 1446 "GetDirectoryRegistrationResponse":{ 1447 "type":"structure", 1448 "members":{ 1449 "DirectoryRegistration":{ 1450 "shape":"DirectoryRegistration", 1451 "documentation":"<p>The directory registration represents the authorization of the connector service with a directory.</p>" 1452 } 1453 } 1454 }, 1455 "GetServicePrincipalNameRequest":{ 1456 "type":"structure", 1457 "required":[ 1458 "ConnectorArn", 1459 "DirectoryRegistrationArn" 1460 ], 1461 "members":{ 1462 "ConnectorArn":{ 1463 "shape":"ConnectorArn", 1464 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 1465 "location":"uri", 1466 "locationName":"ConnectorArn" 1467 }, 1468 "DirectoryRegistrationArn":{ 1469 "shape":"DirectoryRegistrationArn", 1470 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 1471 "location":"uri", 1472 "locationName":"DirectoryRegistrationArn" 1473 } 1474 } 1475 }, 1476 "GetServicePrincipalNameResponse":{ 1477 "type":"structure", 1478 "members":{ 1479 "ServicePrincipalName":{ 1480 "shape":"ServicePrincipalName", 1481 "documentation":"<p>The service principal name that the connector uses to authenticate with Active Directory.</p>" 1482 } 1483 } 1484 }, 1485 "GetTemplateGroupAccessControlEntryRequest":{ 1486 "type":"structure", 1487 "required":[ 1488 "GroupSecurityIdentifier", 1489 "TemplateArn" 1490 ], 1491 "members":{ 1492 "GroupSecurityIdentifier":{ 1493 "shape":"GroupSecurityIdentifier", 1494 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>", 1495 "location":"uri", 1496 "locationName":"GroupSecurityIdentifier" 1497 }, 1498 "TemplateArn":{ 1499 "shape":"TemplateArn", 1500 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1501 "location":"uri", 1502 "locationName":"TemplateArn" 1503 } 1504 } 1505 }, 1506 "GetTemplateGroupAccessControlEntryResponse":{ 1507 "type":"structure", 1508 "members":{ 1509 "AccessControlEntry":{ 1510 "shape":"AccessControlEntry", 1511 "documentation":"<p>An access control entry allows or denies an Active Directory group from enrolling and/or autoenrolling with a template.</p>" 1512 } 1513 } 1514 }, 1515 "GetTemplateRequest":{ 1516 "type":"structure", 1517 "required":["TemplateArn"], 1518 "members":{ 1519 "TemplateArn":{ 1520 "shape":"TemplateArn", 1521 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1522 "location":"uri", 1523 "locationName":"TemplateArn" 1524 } 1525 } 1526 }, 1527 "GetTemplateResponse":{ 1528 "type":"structure", 1529 "members":{ 1530 "Template":{ 1531 "shape":"Template", 1532 "documentation":"<p>A certificate template that the connector uses to issue certificates from a private CA.</p>" 1533 } 1534 } 1535 }, 1536 "GroupSecurityIdentifier":{ 1537 "type":"string", 1538 "max":256, 1539 "min":7, 1540 "pattern":"^S-[0-9]-([0-9]+-){1,14}[0-9]+$" 1541 }, 1542 "HashAlgorithm":{ 1543 "type":"string", 1544 "enum":[ 1545 "SHA256", 1546 "SHA384", 1547 "SHA512" 1548 ] 1549 }, 1550 "Integer":{ 1551 "type":"integer", 1552 "box":true 1553 }, 1554 "InternalServerException":{ 1555 "type":"structure", 1556 "required":["Message"], 1557 "members":{ 1558 "Message":{"shape":"String"} 1559 }, 1560 "documentation":"<p>The request processing has failed because of an unknown error, exception or failure with an internal server. </p>", 1561 "error":{"httpStatusCode":500}, 1562 "exception":true, 1563 "fault":true, 1564 "retryable":{"throttling":false} 1565 }, 1566 "KeySpec":{ 1567 "type":"string", 1568 "enum":[ 1569 "KEY_EXCHANGE", 1570 "SIGNATURE" 1571 ] 1572 }, 1573 "KeyUsage":{ 1574 "type":"structure", 1575 "required":["UsageFlags"], 1576 "members":{ 1577 "Critical":{ 1578 "shape":"Boolean", 1579 "documentation":"<p>Sets the key usage extension to critical.</p>" 1580 }, 1581 "UsageFlags":{ 1582 "shape":"KeyUsageFlags", 1583 "documentation":"<p>The key usage flags represent the purpose (e.g., encipherment, signature) of the key contained in the certificate.</p>" 1584 } 1585 }, 1586 "documentation":"<p>The key usage extension defines the purpose (e.g., encipherment, signature) of the key contained in the certificate.</p>" 1587 }, 1588 "KeyUsageFlags":{ 1589 "type":"structure", 1590 "members":{ 1591 "DataEncipherment":{ 1592 "shape":"Boolean", 1593 "documentation":"<p>DataEncipherment is asserted when the subject public key is used for directly enciphering raw user data without the use of an intermediate symmetric cipher.</p>" 1594 }, 1595 "DigitalSignature":{ 1596 "shape":"Boolean", 1597 "documentation":"<p>The digitalSignature is asserted when the subject public key is used for verifying digital signatures.</p>" 1598 }, 1599 "KeyAgreement":{ 1600 "shape":"Boolean", 1601 "documentation":"<p>KeyAgreement is asserted when the subject public key is used for key agreement.</p>" 1602 }, 1603 "KeyEncipherment":{ 1604 "shape":"Boolean", 1605 "documentation":"<p>KeyEncipherment is asserted when the subject public key is used for enciphering private or secret keys, i.e., for key transport.</p>" 1606 }, 1607 "NonRepudiation":{ 1608 "shape":"Boolean", 1609 "documentation":"<p>NonRepudiation is asserted when the subject public key is used to verify digital signatures.</p>" 1610 } 1611 }, 1612 "documentation":"<p>The key usage flags represent the purpose (e.g., encipherment, signature) of the key contained in the certificate.</p>" 1613 }, 1614 "KeyUsageProperty":{ 1615 "type":"structure", 1616 "members":{ 1617 "PropertyFlags":{ 1618 "shape":"KeyUsagePropertyFlags", 1619 "documentation":"<p>You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both. </p>" 1620 }, 1621 "PropertyType":{ 1622 "shape":"KeyUsagePropertyType", 1623 "documentation":"<p>You can specify all key usages using property type ALL. You can use property type or property flags but not both. </p>" 1624 } 1625 }, 1626 "documentation":"<p>The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.</p>", 1627 "union":true 1628 }, 1629 "KeyUsagePropertyFlags":{ 1630 "type":"structure", 1631 "members":{ 1632 "Decrypt":{ 1633 "shape":"Boolean", 1634 "documentation":"<p>Allows key for encryption and decryption.</p>" 1635 }, 1636 "KeyAgreement":{ 1637 "shape":"Boolean", 1638 "documentation":"<p>Allows key exchange without encryption.</p>" 1639 }, 1640 "Sign":{ 1641 "shape":"Boolean", 1642 "documentation":"<p>Allow key use for digital signature.</p>" 1643 } 1644 }, 1645 "documentation":"<p>Specifies key usage.</p>" 1646 }, 1647 "KeyUsagePropertyType":{ 1648 "type":"string", 1649 "enum":["ALL"] 1650 }, 1651 "ListConnectorsRequest":{ 1652 "type":"structure", 1653 "members":{ 1654 "MaxResults":{ 1655 "shape":"MaxResults", 1656 "documentation":"<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>", 1657 "location":"querystring", 1658 "locationName":"MaxResults" 1659 }, 1660 "NextToken":{ 1661 "shape":"NextToken", 1662 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>", 1663 "location":"querystring", 1664 "locationName":"NextToken" 1665 } 1666 } 1667 }, 1668 "ListConnectorsResponse":{ 1669 "type":"structure", 1670 "members":{ 1671 "Connectors":{ 1672 "shape":"ConnectorList", 1673 "documentation":"<p>Summary information about each connector you have created.</p>" 1674 }, 1675 "NextToken":{ 1676 "shape":"NextToken", 1677 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.</p>" 1678 } 1679 } 1680 }, 1681 "ListDirectoryRegistrationsRequest":{ 1682 "type":"structure", 1683 "members":{ 1684 "MaxResults":{ 1685 "shape":"MaxResults", 1686 "documentation":"<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>", 1687 "location":"querystring", 1688 "locationName":"MaxResults" 1689 }, 1690 "NextToken":{ 1691 "shape":"NextToken", 1692 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>", 1693 "location":"querystring", 1694 "locationName":"NextToken" 1695 } 1696 } 1697 }, 1698 "ListDirectoryRegistrationsResponse":{ 1699 "type":"structure", 1700 "members":{ 1701 "DirectoryRegistrations":{ 1702 "shape":"DirectoryRegistrationList", 1703 "documentation":"<p>Summary information about each directory registration you have created.</p>" 1704 }, 1705 "NextToken":{ 1706 "shape":"NextToken", 1707 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>" 1708 } 1709 } 1710 }, 1711 "ListServicePrincipalNamesRequest":{ 1712 "type":"structure", 1713 "required":["DirectoryRegistrationArn"], 1714 "members":{ 1715 "DirectoryRegistrationArn":{ 1716 "shape":"DirectoryRegistrationArn", 1717 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>", 1718 "location":"uri", 1719 "locationName":"DirectoryRegistrationArn" 1720 }, 1721 "MaxResults":{ 1722 "shape":"MaxResults", 1723 "documentation":"<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>", 1724 "location":"querystring", 1725 "locationName":"MaxResults" 1726 }, 1727 "NextToken":{ 1728 "shape":"NextToken", 1729 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>", 1730 "location":"querystring", 1731 "locationName":"NextToken" 1732 } 1733 } 1734 }, 1735 "ListServicePrincipalNamesResponse":{ 1736 "type":"structure", 1737 "members":{ 1738 "NextToken":{ 1739 "shape":"NextToken", 1740 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>" 1741 }, 1742 "ServicePrincipalNames":{ 1743 "shape":"ServicePrincipalNameList", 1744 "documentation":"<p>The service principal name, if any, that the connector uses to authenticate with Active Directory.</p>" 1745 } 1746 } 1747 }, 1748 "ListTagsForResourceRequest":{ 1749 "type":"structure", 1750 "required":["ResourceArn"], 1751 "members":{ 1752 "ResourceArn":{ 1753 "shape":"String", 1754 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you created the resource. </p>", 1755 "location":"uri", 1756 "locationName":"ResourceArn" 1757 } 1758 } 1759 }, 1760 "ListTagsForResourceResponse":{ 1761 "type":"structure", 1762 "members":{ 1763 "Tags":{ 1764 "shape":"Tags", 1765 "documentation":"<p>The tags, if any, that are associated with your resource.</p>" 1766 } 1767 } 1768 }, 1769 "ListTemplateGroupAccessControlEntriesRequest":{ 1770 "type":"structure", 1771 "required":["TemplateArn"], 1772 "members":{ 1773 "MaxResults":{ 1774 "shape":"MaxResults", 1775 "documentation":"<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>", 1776 "location":"querystring", 1777 "locationName":"MaxResults" 1778 }, 1779 "NextToken":{ 1780 "shape":"NextToken", 1781 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>", 1782 "location":"querystring", 1783 "locationName":"NextToken" 1784 }, 1785 "TemplateArn":{ 1786 "shape":"TemplateArn", 1787 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 1788 "location":"uri", 1789 "locationName":"TemplateArn" 1790 } 1791 } 1792 }, 1793 "ListTemplateGroupAccessControlEntriesResponse":{ 1794 "type":"structure", 1795 "members":{ 1796 "AccessControlEntries":{ 1797 "shape":"AccessControlEntryList", 1798 "documentation":"<p>An access control entry grants or denies permission to an Active Directory group to enroll certificates for a template.</p>" 1799 }, 1800 "NextToken":{ 1801 "shape":"NextToken", 1802 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>" 1803 } 1804 } 1805 }, 1806 "ListTemplatesRequest":{ 1807 "type":"structure", 1808 "required":["ConnectorArn"], 1809 "members":{ 1810 "ConnectorArn":{ 1811 "shape":"ConnectorArn", 1812 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>", 1813 "location":"querystring", 1814 "locationName":"ConnectorArn" 1815 }, 1816 "MaxResults":{ 1817 "shape":"MaxResults", 1818 "documentation":"<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>", 1819 "location":"querystring", 1820 "locationName":"MaxResults" 1821 }, 1822 "NextToken":{ 1823 "shape":"NextToken", 1824 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>", 1825 "location":"querystring", 1826 "locationName":"NextToken" 1827 } 1828 } 1829 }, 1830 "ListTemplatesResponse":{ 1831 "type":"structure", 1832 "members":{ 1833 "NextToken":{ 1834 "shape":"NextToken", 1835 "documentation":"<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>" 1836 }, 1837 "Templates":{ 1838 "shape":"TemplateList", 1839 "documentation":"<p>Custom configuration templates used when issuing a certificate. </p>" 1840 } 1841 } 1842 }, 1843 "MaxResults":{ 1844 "type":"integer", 1845 "box":true, 1846 "max":1000, 1847 "min":1 1848 }, 1849 "NextToken":{ 1850 "type":"string", 1851 "max":1000, 1852 "min":1, 1853 "pattern":"^(?:[A-Za-z0-9_-]{4})*(?:[A-Za-z0-9_-]{2}==|[A-Za-z0-9_-]{3}=)?$" 1854 }, 1855 "PrivateKeyAlgorithm":{ 1856 "type":"string", 1857 "enum":[ 1858 "RSA", 1859 "ECDH_P256", 1860 "ECDH_P384", 1861 "ECDH_P521" 1862 ] 1863 }, 1864 "PrivateKeyAttributesV2":{ 1865 "type":"structure", 1866 "required":[ 1867 "KeySpec", 1868 "MinimalKeyLength" 1869 ], 1870 "members":{ 1871 "CryptoProviders":{ 1872 "shape":"CryptoProvidersList", 1873 "documentation":"<p>Defines the cryptographic providers used to generate the private key.</p>" 1874 }, 1875 "KeySpec":{ 1876 "shape":"KeySpec", 1877 "documentation":"<p>Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\" value.</p>" 1878 }, 1879 "MinimalKeyLength":{ 1880 "shape":"PrivateKeyAttributesV2MinimalKeyLengthInteger", 1881 "documentation":"<p>Set the minimum key length of the private key.</p>" 1882 } 1883 }, 1884 "documentation":"<p>Defines the attributes of the private key.</p>" 1885 }, 1886 "PrivateKeyAttributesV2MinimalKeyLengthInteger":{ 1887 "type":"integer", 1888 "box":true, 1889 "min":1 1890 }, 1891 "PrivateKeyAttributesV3":{ 1892 "type":"structure", 1893 "required":[ 1894 "Algorithm", 1895 "KeySpec", 1896 "KeyUsageProperty", 1897 "MinimalKeyLength" 1898 ], 1899 "members":{ 1900 "Algorithm":{ 1901 "shape":"PrivateKeyAlgorithm", 1902 "documentation":"<p>Defines the algorithm used to generate the private key.</p>" 1903 }, 1904 "CryptoProviders":{ 1905 "shape":"CryptoProvidersList", 1906 "documentation":"<p>Defines the cryptographic providers used to generate the private key.</p>" 1907 }, 1908 "KeySpec":{ 1909 "shape":"KeySpec", 1910 "documentation":"<p>Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\" value.</p>" 1911 }, 1912 "KeyUsageProperty":{ 1913 "shape":"KeyUsageProperty", 1914 "documentation":"<p>The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.</p>" 1915 }, 1916 "MinimalKeyLength":{ 1917 "shape":"PrivateKeyAttributesV3MinimalKeyLengthInteger", 1918 "documentation":"<p>Set the minimum key length of the private key.</p>" 1919 } 1920 }, 1921 "documentation":"<p>Defines the attributes of the private key.</p>" 1922 }, 1923 "PrivateKeyAttributesV3MinimalKeyLengthInteger":{ 1924 "type":"integer", 1925 "box":true, 1926 "min":1 1927 }, 1928 "PrivateKeyAttributesV4":{ 1929 "type":"structure", 1930 "required":[ 1931 "KeySpec", 1932 "MinimalKeyLength" 1933 ], 1934 "members":{ 1935 "Algorithm":{ 1936 "shape":"PrivateKeyAlgorithm", 1937 "documentation":"<p>Defines the algorithm used to generate the private key.</p>" 1938 }, 1939 "CryptoProviders":{ 1940 "shape":"CryptoProvidersList", 1941 "documentation":"<p>Defines the cryptographic providers used to generate the private key.</p>" 1942 }, 1943 "KeySpec":{ 1944 "shape":"KeySpec", 1945 "documentation":"<p>Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\" value.</p>" 1946 }, 1947 "KeyUsageProperty":{ 1948 "shape":"KeyUsageProperty", 1949 "documentation":"<p>The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.</p>" 1950 }, 1951 "MinimalKeyLength":{ 1952 "shape":"PrivateKeyAttributesV4MinimalKeyLengthInteger", 1953 "documentation":"<p>Set the minimum key length of the private key.</p>" 1954 } 1955 }, 1956 "documentation":"<p>Defines the attributes of the private key.</p>" 1957 }, 1958 "PrivateKeyAttributesV4MinimalKeyLengthInteger":{ 1959 "type":"integer", 1960 "box":true, 1961 "min":1 1962 }, 1963 "PrivateKeyFlagsV2":{ 1964 "type":"structure", 1965 "required":["ClientVersion"], 1966 "members":{ 1967 "ClientVersion":{ 1968 "shape":"ClientCompatibilityV2", 1969 "documentation":"<p>Defines the minimum client compatibility.</p>" 1970 }, 1971 "ExportableKey":{ 1972 "shape":"Boolean", 1973 "documentation":"<p>Allows the private key to be exported.</p>" 1974 }, 1975 "StrongKeyProtectionRequired":{ 1976 "shape":"Boolean", 1977 "documentation":"<p>Require user input when using the private key for enrollment.</p>" 1978 } 1979 }, 1980 "documentation":"<p>Private key flags for v2 templates specify the client compatibility, if the private key can be exported, and if user input is required when using a private key.</p>" 1981 }, 1982 "PrivateKeyFlagsV3":{ 1983 "type":"structure", 1984 "required":["ClientVersion"], 1985 "members":{ 1986 "ClientVersion":{ 1987 "shape":"ClientCompatibilityV3", 1988 "documentation":"<p>Defines the minimum client compatibility.</p>" 1989 }, 1990 "ExportableKey":{ 1991 "shape":"Boolean", 1992 "documentation":"<p>Allows the private key to be exported.</p>" 1993 }, 1994 "RequireAlternateSignatureAlgorithm":{ 1995 "shape":"Boolean", 1996 "documentation":"<p>Reguires the PKCS #1 v2.1 signature format for certificates. You should verify that your CA, objects, and applications can accept this signature format.</p>" 1997 }, 1998 "StrongKeyProtectionRequired":{ 1999 "shape":"Boolean", 2000 "documentation":"<p>Requirer user input when using the private key for enrollment.</p>" 2001 } 2002 }, 2003 "documentation":"<p>Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.</p>" 2004 }, 2005 "PrivateKeyFlagsV4":{ 2006 "type":"structure", 2007 "required":["ClientVersion"], 2008 "members":{ 2009 "ClientVersion":{ 2010 "shape":"ClientCompatibilityV4", 2011 "documentation":"<p>Defines the minimum client compatibility.</p>" 2012 }, 2013 "ExportableKey":{ 2014 "shape":"Boolean", 2015 "documentation":"<p>Allows the private key to be exported.</p>" 2016 }, 2017 "RequireAlternateSignatureAlgorithm":{ 2018 "shape":"Boolean", 2019 "documentation":"<p>Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your CA, objects, and applications can accept this signature format.</p>" 2020 }, 2021 "RequireSameKeyRenewal":{ 2022 "shape":"Boolean", 2023 "documentation":"<p>Renew certificate using the same private key.</p>" 2024 }, 2025 "StrongKeyProtectionRequired":{ 2026 "shape":"Boolean", 2027 "documentation":"<p>Require user input when using the private key for enrollment.</p>" 2028 }, 2029 "UseLegacyProvider":{ 2030 "shape":"Boolean", 2031 "documentation":"<p>Specifies the cryptographic service provider category used to generate private keys. Set to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage Providers.</p>" 2032 } 2033 }, 2034 "documentation":"<p>Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.</p>" 2035 }, 2036 "ResourceNotFoundException":{ 2037 "type":"structure", 2038 "required":[ 2039 "Message", 2040 "ResourceId", 2041 "ResourceType" 2042 ], 2043 "members":{ 2044 "Message":{"shape":"String"}, 2045 "ResourceId":{ 2046 "shape":"String", 2047 "documentation":"<p>The identifier of the Amazon Web Services resource.</p>" 2048 }, 2049 "ResourceType":{ 2050 "shape":"String", 2051 "documentation":"<p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>" 2052 } 2053 }, 2054 "documentation":"<p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>", 2055 "error":{ 2056 "httpStatusCode":404, 2057 "senderFault":true 2058 }, 2059 "exception":true 2060 }, 2061 "SecurityGroupId":{ 2062 "type":"string", 2063 "max":20, 2064 "min":11, 2065 "pattern":"^(?:sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" 2066 }, 2067 "SecurityGroupIdList":{ 2068 "type":"list", 2069 "member":{"shape":"SecurityGroupId"}, 2070 "max":4, 2071 "min":1 2072 }, 2073 "ServicePrincipalName":{ 2074 "type":"structure", 2075 "members":{ 2076 "ConnectorArn":{ 2077 "shape":"ConnectorArn", 2078 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector.html</a>.</p>" 2079 }, 2080 "CreatedAt":{ 2081 "shape":"Timestamp", 2082 "documentation":"<p>The date and time that the service principal name was created.</p>" 2083 }, 2084 "DirectoryRegistrationArn":{ 2085 "shape":"DirectoryRegistrationArn", 2086 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>" 2087 }, 2088 "Status":{ 2089 "shape":"ServicePrincipalNameStatus", 2090 "documentation":"<p>The status of a service principal name.</p>" 2091 }, 2092 "StatusReason":{ 2093 "shape":"ServicePrincipalNameStatusReason", 2094 "documentation":"<p>Additional information for the status of a service principal name if the status is failed.</p>" 2095 }, 2096 "UpdatedAt":{ 2097 "shape":"Timestamp", 2098 "documentation":"<p>The date and time that the service principal name was updated.</p>" 2099 } 2100 }, 2101 "documentation":"<p>The service principal name that the connector uses to authenticate with Active Directory.</p>" 2102 }, 2103 "ServicePrincipalNameList":{ 2104 "type":"list", 2105 "member":{"shape":"ServicePrincipalNameSummary"} 2106 }, 2107 "ServicePrincipalNameStatus":{ 2108 "type":"string", 2109 "enum":[ 2110 "CREATING", 2111 "ACTIVE", 2112 "DELETING", 2113 "FAILED" 2114 ] 2115 }, 2116 "ServicePrincipalNameStatusReason":{ 2117 "type":"string", 2118 "enum":[ 2119 "DIRECTORY_ACCESS_DENIED", 2120 "DIRECTORY_NOT_REACHABLE", 2121 "DIRECTORY_RESOURCE_NOT_FOUND", 2122 "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT", 2123 "INTERNAL_FAILURE" 2124 ] 2125 }, 2126 "ServicePrincipalNameSummary":{ 2127 "type":"structure", 2128 "members":{ 2129 "ConnectorArn":{ 2130 "shape":"ConnectorArn", 2131 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>" 2132 }, 2133 "CreatedAt":{ 2134 "shape":"Timestamp", 2135 "documentation":"<p>The date and time that the service principal name was created.</p>" 2136 }, 2137 "DirectoryRegistrationArn":{ 2138 "shape":"DirectoryRegistrationArn", 2139 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration.html\">CreateDirectoryRegistration</a>.</p>" 2140 }, 2141 "Status":{ 2142 "shape":"ServicePrincipalNameStatus", 2143 "documentation":"<p>The status of a service principal name.</p>" 2144 }, 2145 "StatusReason":{ 2146 "shape":"ServicePrincipalNameStatusReason", 2147 "documentation":"<p>Additional information for the status of a service principal name if the status is failed.</p>" 2148 }, 2149 "UpdatedAt":{ 2150 "shape":"Timestamp", 2151 "documentation":"<p>Time when the service principal name was updated.</p>" 2152 } 2153 }, 2154 "documentation":"<p>The service principal name that the connector uses to authenticate with Active Directory.</p>" 2155 }, 2156 "ServiceQuotaExceededException":{ 2157 "type":"structure", 2158 "required":[ 2159 "Message", 2160 "QuotaCode", 2161 "ResourceId", 2162 "ResourceType", 2163 "ServiceCode" 2164 ], 2165 "members":{ 2166 "Message":{"shape":"String"}, 2167 "QuotaCode":{ 2168 "shape":"String", 2169 "documentation":"<p>The code associated with the service quota.</p>" 2170 }, 2171 "ResourceId":{ 2172 "shape":"String", 2173 "documentation":"<p>The identifier of the Amazon Web Services resource.</p>" 2174 }, 2175 "ResourceType":{ 2176 "shape":"String", 2177 "documentation":"<p>The resource type, which can be one of <code>Connector</code>, <code>Template</code>, <code>TemplateGroupAccessControlEntry</code>, <code>ServicePrincipalName</code>, or <code>DirectoryRegistration</code>.</p>" 2178 }, 2179 "ServiceCode":{ 2180 "shape":"String", 2181 "documentation":"<p>Identifies the originating service.</p>" 2182 } 2183 }, 2184 "documentation":"<p>Request would cause a service quota to be exceeded.</p>", 2185 "error":{ 2186 "httpStatusCode":402, 2187 "senderFault":true 2188 }, 2189 "exception":true 2190 }, 2191 "String":{"type":"string"}, 2192 "SubjectNameFlagsV2":{ 2193 "type":"structure", 2194 "members":{ 2195 "RequireCommonName":{ 2196 "shape":"Boolean", 2197 "documentation":"<p>Include the common name in the subject name.</p>" 2198 }, 2199 "RequireDirectoryPath":{ 2200 "shape":"Boolean", 2201 "documentation":"<p>Include the directory path in the subject name.</p>" 2202 }, 2203 "RequireDnsAsCn":{ 2204 "shape":"Boolean", 2205 "documentation":"<p>Include the DNS as common name in the subject name.</p>" 2206 }, 2207 "RequireEmail":{ 2208 "shape":"Boolean", 2209 "documentation":"<p>Include the subject's email in the subject name.</p>" 2210 }, 2211 "SanRequireDirectoryGuid":{ 2212 "shape":"Boolean", 2213 "documentation":"<p>Include the globally unique identifier (GUID) in the subject alternate name.</p>" 2214 }, 2215 "SanRequireDns":{ 2216 "shape":"Boolean", 2217 "documentation":"<p>Include the DNS in the subject alternate name.</p>" 2218 }, 2219 "SanRequireDomainDns":{ 2220 "shape":"Boolean", 2221 "documentation":"<p>Include the domain DNS in the subject alternate name.</p>" 2222 }, 2223 "SanRequireEmail":{ 2224 "shape":"Boolean", 2225 "documentation":"<p>Include the subject's email in the subject alternate name.</p>" 2226 }, 2227 "SanRequireSpn":{ 2228 "shape":"Boolean", 2229 "documentation":"<p>Include the service principal name (SPN) in the subject alternate name.</p>" 2230 }, 2231 "SanRequireUpn":{ 2232 "shape":"Boolean", 2233 "documentation":"<p>Include the user principal name (UPN) in the subject alternate name.</p>" 2234 } 2235 }, 2236 "documentation":"<p>Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.</p>" 2237 }, 2238 "SubjectNameFlagsV3":{ 2239 "type":"structure", 2240 "members":{ 2241 "RequireCommonName":{ 2242 "shape":"Boolean", 2243 "documentation":"<p>Include the common name in the subject name. </p>" 2244 }, 2245 "RequireDirectoryPath":{ 2246 "shape":"Boolean", 2247 "documentation":"<p>Include the directory path in the subject name.</p>" 2248 }, 2249 "RequireDnsAsCn":{ 2250 "shape":"Boolean", 2251 "documentation":"<p>Include the DNS as common name in the subject name.</p>" 2252 }, 2253 "RequireEmail":{ 2254 "shape":"Boolean", 2255 "documentation":"<p>Include the subject's email in the subject name.</p>" 2256 }, 2257 "SanRequireDirectoryGuid":{ 2258 "shape":"Boolean", 2259 "documentation":"<p>Include the globally unique identifier (GUID) in the subject alternate name.</p>" 2260 }, 2261 "SanRequireDns":{ 2262 "shape":"Boolean", 2263 "documentation":"<p>Include the DNS in the subject alternate name.</p>" 2264 }, 2265 "SanRequireDomainDns":{ 2266 "shape":"Boolean", 2267 "documentation":"<p>Include the domain DNS in the subject alternate name.</p>" 2268 }, 2269 "SanRequireEmail":{ 2270 "shape":"Boolean", 2271 "documentation":"<p>Include the subject's email in the subject alternate name.</p>" 2272 }, 2273 "SanRequireSpn":{ 2274 "shape":"Boolean", 2275 "documentation":"<p>Include the service principal name (SPN) in the subject alternate name.</p>" 2276 }, 2277 "SanRequireUpn":{ 2278 "shape":"Boolean", 2279 "documentation":"<p>Include the user principal name (UPN) in the subject alternate name.</p>" 2280 } 2281 }, 2282 "documentation":"<p>Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.</p>" 2283 }, 2284 "SubjectNameFlagsV4":{ 2285 "type":"structure", 2286 "members":{ 2287 "RequireCommonName":{ 2288 "shape":"Boolean", 2289 "documentation":"<p>Include the common name in the subject name.</p>" 2290 }, 2291 "RequireDirectoryPath":{ 2292 "shape":"Boolean", 2293 "documentation":"<p>Include the directory path in the subject name.</p>" 2294 }, 2295 "RequireDnsAsCn":{ 2296 "shape":"Boolean", 2297 "documentation":"<p>Include the DNS as common name in the subject name.</p>" 2298 }, 2299 "RequireEmail":{ 2300 "shape":"Boolean", 2301 "documentation":"<p>Include the subject's email in the subject name.</p>" 2302 }, 2303 "SanRequireDirectoryGuid":{ 2304 "shape":"Boolean", 2305 "documentation":"<p>Include the globally unique identifier (GUID) in the subject alternate name.</p>" 2306 }, 2307 "SanRequireDns":{ 2308 "shape":"Boolean", 2309 "documentation":"<p>Include the DNS in the subject alternate name.</p>" 2310 }, 2311 "SanRequireDomainDns":{ 2312 "shape":"Boolean", 2313 "documentation":"<p>Include the domain DNS in the subject alternate name.</p>" 2314 }, 2315 "SanRequireEmail":{ 2316 "shape":"Boolean", 2317 "documentation":"<p>Include the subject's email in the subject alternate name.</p>" 2318 }, 2319 "SanRequireSpn":{ 2320 "shape":"Boolean", 2321 "documentation":"<p>Include the service principal name (SPN) in the subject alternate name.</p>" 2322 }, 2323 "SanRequireUpn":{ 2324 "shape":"Boolean", 2325 "documentation":"<p>Include the user principal name (UPN) in the subject alternate name.</p>" 2326 } 2327 }, 2328 "documentation":"<p>Information to include in the subject name and alternate subject name of the certificate. The subject name can be common name, directory path, DNS as common name, or left blank. You can optionally include email to the subject name for user templates. If you leave the subject name blank then you must set a subject alternate name. The subject alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email, service principal name (SPN), and user principal name (UPN). You can leave the SAN blank. If you leave the SAN blank, then you must set a subject name.</p>" 2329 }, 2330 "TagKeyList":{ 2331 "type":"list", 2332 "member":{"shape":"String"} 2333 }, 2334 "TagResourceRequest":{ 2335 "type":"structure", 2336 "required":[ 2337 "ResourceArn", 2338 "Tags" 2339 ], 2340 "members":{ 2341 "ResourceArn":{ 2342 "shape":"String", 2343 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you created the resource. </p>", 2344 "location":"uri", 2345 "locationName":"ResourceArn" 2346 }, 2347 "Tags":{ 2348 "shape":"Tags", 2349 "documentation":"<p>Metadata assigned to a directory registration consisting of a key-value pair.</p>" 2350 } 2351 } 2352 }, 2353 "Tags":{ 2354 "type":"map", 2355 "key":{"shape":"String"}, 2356 "value":{"shape":"String"} 2357 }, 2358 "Template":{ 2359 "type":"structure", 2360 "members":{ 2361 "Arn":{ 2362 "shape":"TemplateArn", 2363 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>" 2364 }, 2365 "ConnectorArn":{ 2366 "shape":"ConnectorArn", 2367 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>" 2368 }, 2369 "CreatedAt":{ 2370 "shape":"Timestamp", 2371 "documentation":"<p>The date and time that the template was created.</p>" 2372 }, 2373 "Definition":{ 2374 "shape":"TemplateDefinition", 2375 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2376 }, 2377 "Name":{ 2378 "shape":"TemplateName", 2379 "documentation":"<p>Name of the templates. Template names must be unique.</p>" 2380 }, 2381 "ObjectIdentifier":{ 2382 "shape":"CustomObjectIdentifier", 2383 "documentation":"<p>Object identifier of a template.</p>" 2384 }, 2385 "PolicySchema":{ 2386 "shape":"Integer", 2387 "documentation":"<p>The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.</p>" 2388 }, 2389 "Revision":{ 2390 "shape":"TemplateRevision", 2391 "documentation":"<p>The version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.</p>" 2392 }, 2393 "Status":{ 2394 "shape":"TemplateStatus", 2395 "documentation":"<p>Status of the template. Status can be creating, active, deleting, or failed.</p>" 2396 }, 2397 "UpdatedAt":{ 2398 "shape":"Timestamp", 2399 "documentation":"<p>The date and time that the template was updated.</p>" 2400 } 2401 }, 2402 "documentation":"<p>An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership. </p>" 2403 }, 2404 "TemplateArn":{ 2405 "type":"string", 2406 "max":200, 2407 "min":5, 2408 "pattern":"^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\\/template\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" 2409 }, 2410 "TemplateDefinition":{ 2411 "type":"structure", 2412 "members":{ 2413 "TemplateV2":{ 2414 "shape":"TemplateV2", 2415 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2416 }, 2417 "TemplateV3":{ 2418 "shape":"TemplateV3", 2419 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2420 }, 2421 "TemplateV4":{ 2422 "shape":"TemplateV4", 2423 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2424 } 2425 }, 2426 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>", 2427 "union":true 2428 }, 2429 "TemplateList":{ 2430 "type":"list", 2431 "member":{"shape":"TemplateSummary"} 2432 }, 2433 "TemplateName":{ 2434 "type":"string", 2435 "max":64, 2436 "min":1, 2437 "pattern":"^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$" 2438 }, 2439 "TemplateNameList":{ 2440 "type":"list", 2441 "member":{"shape":"TemplateName"}, 2442 "max":100, 2443 "min":1 2444 }, 2445 "TemplateRevision":{ 2446 "type":"structure", 2447 "required":[ 2448 "MajorRevision", 2449 "MinorRevision" 2450 ], 2451 "members":{ 2452 "MajorRevision":{ 2453 "shape":"Integer", 2454 "documentation":"<p>The revision version of the template. Re-enrolling all certificate holders will increment the major revision.</p>" 2455 }, 2456 "MinorRevision":{ 2457 "shape":"Integer", 2458 "documentation":"<p>The revision version of the template. Re-enrolling all certificate holders will increment the major revision.</p>" 2459 } 2460 }, 2461 "documentation":"<p>The revision version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.</p>" 2462 }, 2463 "TemplateStatus":{ 2464 "type":"string", 2465 "enum":[ 2466 "ACTIVE", 2467 "DELETING" 2468 ] 2469 }, 2470 "TemplateSummary":{ 2471 "type":"structure", 2472 "members":{ 2473 "Arn":{ 2474 "shape":"TemplateArn", 2475 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>" 2476 }, 2477 "ConnectorArn":{ 2478 "shape":"ConnectorArn", 2479 "documentation":"<p> The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html\">CreateConnector</a>.</p>" 2480 }, 2481 "CreatedAt":{ 2482 "shape":"Timestamp", 2483 "documentation":"<p>The date and time that the template was created.</p>" 2484 }, 2485 "Definition":{ 2486 "shape":"TemplateDefinition", 2487 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2488 }, 2489 "Name":{ 2490 "shape":"TemplateName", 2491 "documentation":"<p>Name of the template. The template name must be unique.</p>" 2492 }, 2493 "ObjectIdentifier":{ 2494 "shape":"CustomObjectIdentifier", 2495 "documentation":"<p>Object identifier of a template.</p>" 2496 }, 2497 "PolicySchema":{ 2498 "shape":"Integer", 2499 "documentation":"<p>The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.</p>" 2500 }, 2501 "Revision":{ 2502 "shape":"TemplateRevision", 2503 "documentation":"<p>The revision version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.</p>" 2504 }, 2505 "Status":{ 2506 "shape":"TemplateStatus", 2507 "documentation":"<p>Status of the template. Status can be creating, active, deleting, or failed.</p>" 2508 }, 2509 "UpdatedAt":{ 2510 "shape":"Timestamp", 2511 "documentation":"<p>The date and time that the template was updated.</p>" 2512 } 2513 }, 2514 "documentation":"<p>An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership.</p>" 2515 }, 2516 "TemplateV2":{ 2517 "type":"structure", 2518 "required":[ 2519 "CertificateValidity", 2520 "EnrollmentFlags", 2521 "Extensions", 2522 "GeneralFlags", 2523 "PrivateKeyAttributes", 2524 "PrivateKeyFlags", 2525 "SubjectNameFlags" 2526 ], 2527 "members":{ 2528 "CertificateValidity":{ 2529 "shape":"CertificateValidity", 2530 "documentation":"<p>Certificate validity describes the validity and renewal periods of a certificate.</p>" 2531 }, 2532 "EnrollmentFlags":{ 2533 "shape":"EnrollmentFlagsV2", 2534 "documentation":"<p>Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.</p>" 2535 }, 2536 "Extensions":{ 2537 "shape":"ExtensionsV2", 2538 "documentation":"<p>Extensions describe the key usage extensions and application policies for a template.</p>" 2539 }, 2540 "GeneralFlags":{ 2541 "shape":"GeneralFlagsV2", 2542 "documentation":"<p>General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.</p>" 2543 }, 2544 "PrivateKeyAttributes":{ 2545 "shape":"PrivateKeyAttributesV2", 2546 "documentation":"<p>Private key attributes allow you to specify the minimal key length, key spec, and cryptographic providers for the private key of a certificate for v2 templates. V2 templates allow you to use Legacy Cryptographic Service Providers.</p>" 2547 }, 2548 "PrivateKeyFlags":{ 2549 "shape":"PrivateKeyFlagsV2", 2550 "documentation":"<p>Private key flags for v2 templates specify the client compatibility, if the private key can be exported, and if user input is required when using a private key. </p>" 2551 }, 2552 "SubjectNameFlags":{ 2553 "shape":"SubjectNameFlagsV2", 2554 "documentation":"<p>Subject name flags describe the subject name and subject alternate name that is included in a certificate.</p>" 2555 }, 2556 "SupersededTemplates":{ 2557 "shape":"TemplateNameList", 2558 "documentation":"<p>List of templates in Active Directory that are superseded by this template.</p>" 2559 } 2560 }, 2561 "documentation":"<p>v2 template schema that uses Legacy Cryptographic Providers.</p>" 2562 }, 2563 "TemplateV3":{ 2564 "type":"structure", 2565 "required":[ 2566 "CertificateValidity", 2567 "EnrollmentFlags", 2568 "Extensions", 2569 "GeneralFlags", 2570 "HashAlgorithm", 2571 "PrivateKeyAttributes", 2572 "PrivateKeyFlags", 2573 "SubjectNameFlags" 2574 ], 2575 "members":{ 2576 "CertificateValidity":{ 2577 "shape":"CertificateValidity", 2578 "documentation":"<p>Certificate validity describes the validity and renewal periods of a certificate.</p>" 2579 }, 2580 "EnrollmentFlags":{ 2581 "shape":"EnrollmentFlagsV3", 2582 "documentation":"<p>Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.</p>" 2583 }, 2584 "Extensions":{ 2585 "shape":"ExtensionsV3", 2586 "documentation":"<p>Extensions describe the key usage extensions and application policies for a template.</p>" 2587 }, 2588 "GeneralFlags":{ 2589 "shape":"GeneralFlagsV3", 2590 "documentation":"<p>General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.</p>" 2591 }, 2592 "HashAlgorithm":{ 2593 "shape":"HashAlgorithm", 2594 "documentation":"<p>Specifies the hash algorithm used to hash the private key.</p>" 2595 }, 2596 "PrivateKeyAttributes":{ 2597 "shape":"PrivateKeyAttributesV3", 2598 "documentation":"<p>Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates. V3 templates allow you to use Key Storage Providers.</p>" 2599 }, 2600 "PrivateKeyFlags":{ 2601 "shape":"PrivateKeyFlagsV3", 2602 "documentation":"<p>Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.</p>" 2603 }, 2604 "SubjectNameFlags":{ 2605 "shape":"SubjectNameFlagsV3", 2606 "documentation":"<p>Subject name flags describe the subject name and subject alternate name that is included in a certificate.</p>" 2607 }, 2608 "SupersededTemplates":{ 2609 "shape":"TemplateNameList", 2610 "documentation":"<p>List of templates in Active Directory that are superseded by this template.</p>" 2611 } 2612 }, 2613 "documentation":"<p>v3 template schema that uses Key Storage Providers.</p>" 2614 }, 2615 "TemplateV4":{ 2616 "type":"structure", 2617 "required":[ 2618 "CertificateValidity", 2619 "EnrollmentFlags", 2620 "Extensions", 2621 "GeneralFlags", 2622 "PrivateKeyAttributes", 2623 "PrivateKeyFlags", 2624 "SubjectNameFlags" 2625 ], 2626 "members":{ 2627 "CertificateValidity":{ 2628 "shape":"CertificateValidity", 2629 "documentation":"<p>Certificate validity describes the validity and renewal periods of a certificate.</p>" 2630 }, 2631 "EnrollmentFlags":{ 2632 "shape":"EnrollmentFlagsV4", 2633 "documentation":"<p>Enrollment flags describe the enrollment settings for certificates using the existing private key and deleting expired or revoked certificates.</p>" 2634 }, 2635 "Extensions":{ 2636 "shape":"ExtensionsV4", 2637 "documentation":"<p>Extensions describe the key usage extensions and application policies for a template.</p>" 2638 }, 2639 "GeneralFlags":{ 2640 "shape":"GeneralFlagsV4", 2641 "documentation":"<p>General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.</p>" 2642 }, 2643 "HashAlgorithm":{ 2644 "shape":"HashAlgorithm", 2645 "documentation":"<p>Specifies the hash algorithm used to hash the private key. Hash algorithm can only be specified when using Key Storage Providers.</p>" 2646 }, 2647 "PrivateKeyAttributes":{ 2648 "shape":"PrivateKeyAttributesV4", 2649 "documentation":"<p>Private key attributes allow you to specify the minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v4 templates. V4 templates allow you to use either Key Storage Providers or Legacy Cryptographic Service Providers. You specify the cryptography provider category in private key flags.</p>" 2650 }, 2651 "PrivateKeyFlags":{ 2652 "shape":"PrivateKeyFlagsV4", 2653 "documentation":"<p>Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.</p>" 2654 }, 2655 "SubjectNameFlags":{ 2656 "shape":"SubjectNameFlagsV4", 2657 "documentation":"<p>Subject name flags describe the subject name and subject alternate name that is included in a certificate.</p>" 2658 }, 2659 "SupersededTemplates":{ 2660 "shape":"TemplateNameList", 2661 "documentation":"<p>List of templates in Active Directory that are superseded by this template.</p>" 2662 } 2663 }, 2664 "documentation":"<p>v4 template schema that can use either Legacy Cryptographic Providers or Key Storage Providers.</p>" 2665 }, 2666 "ThrottlingException":{ 2667 "type":"structure", 2668 "required":["Message"], 2669 "members":{ 2670 "Message":{"shape":"String"}, 2671 "QuotaCode":{ 2672 "shape":"String", 2673 "documentation":"<p>The code associated with the quota.</p>" 2674 }, 2675 "ServiceCode":{ 2676 "shape":"String", 2677 "documentation":"<p>Identifies the originating service.</p>" 2678 } 2679 }, 2680 "documentation":"<p>The limit on the number of requests per second was exceeded. </p>", 2681 "error":{ 2682 "httpStatusCode":429, 2683 "senderFault":true 2684 }, 2685 "exception":true, 2686 "retryable":{"throttling":true} 2687 }, 2688 "Timestamp":{"type":"timestamp"}, 2689 "UntagResourceRequest":{ 2690 "type":"structure", 2691 "required":[ 2692 "ResourceArn", 2693 "TagKeys" 2694 ], 2695 "members":{ 2696 "ResourceArn":{ 2697 "shape":"String", 2698 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you created the resource.</p>", 2699 "location":"uri", 2700 "locationName":"ResourceArn" 2701 }, 2702 "TagKeys":{ 2703 "shape":"TagKeyList", 2704 "documentation":"<p>Specifies a list of tag keys that you want to remove from the specified resources.</p>", 2705 "location":"querystring", 2706 "locationName":"tagKeys" 2707 } 2708 } 2709 }, 2710 "UpdateTemplateGroupAccessControlEntryRequest":{ 2711 "type":"structure", 2712 "required":[ 2713 "GroupSecurityIdentifier", 2714 "TemplateArn" 2715 ], 2716 "members":{ 2717 "AccessRights":{ 2718 "shape":"AccessRights", 2719 "documentation":"<p>Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.</p>" 2720 }, 2721 "GroupDisplayName":{ 2722 "shape":"DisplayName", 2723 "documentation":"<p>Name of the Active Directory group. This name does not need to match the group name in Active Directory.</p>" 2724 }, 2725 "GroupSecurityIdentifier":{ 2726 "shape":"GroupSecurityIdentifier", 2727 "documentation":"<p>Security identifier (SID) of the group object from Active Directory. The SID starts with \"S-\".</p>", 2728 "location":"uri", 2729 "locationName":"GroupSecurityIdentifier" 2730 }, 2731 "TemplateArn":{ 2732 "shape":"TemplateArn", 2733 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 2734 "location":"uri", 2735 "locationName":"TemplateArn" 2736 } 2737 } 2738 }, 2739 "UpdateTemplateRequest":{ 2740 "type":"structure", 2741 "required":["TemplateArn"], 2742 "members":{ 2743 "Definition":{ 2744 "shape":"TemplateDefinition", 2745 "documentation":"<p>Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.</p>" 2746 }, 2747 "ReenrollAllCertificateHolders":{ 2748 "shape":"Boolean", 2749 "documentation":"<p>This setting allows the major version of a template to be increased automatically. All members of Active Directory groups that are allowed to enroll with a template will receive a new certificate issued using that template.</p>" 2750 }, 2751 "TemplateArn":{ 2752 "shape":"TemplateArn", 2753 "documentation":"<p>The Amazon Resource Name (ARN) that was returned when you called <a href=\"https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a>.</p>", 2754 "location":"uri", 2755 "locationName":"TemplateArn" 2756 } 2757 } 2758 }, 2759 "ValidationException":{ 2760 "type":"structure", 2761 "required":["Message"], 2762 "members":{ 2763 "Message":{"shape":"String"}, 2764 "Reason":{ 2765 "shape":"ValidationExceptionReason", 2766 "documentation":"<p>The reason for the validation error. This won't be return for every validation exception.</p>" 2767 } 2768 }, 2769 "documentation":"<p>An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid. </p>", 2770 "error":{ 2771 "httpStatusCode":400, 2772 "senderFault":true 2773 }, 2774 "exception":true 2775 }, 2776 "ValidationExceptionReason":{ 2777 "type":"string", 2778 "enum":[ 2779 "FIELD_VALIDATION_FAILED", 2780 "INVALID_PERMISSION", 2781 "INVALID_STATE", 2782 "MISMATCHED_CONNECTOR", 2783 "MISMATCHED_VPC", 2784 "NO_CLIENT_TOKEN", 2785 "UNKNOWN_OPERATION", 2786 "OTHER" 2787 ] 2788 }, 2789 "ValidityPeriod":{ 2790 "type":"structure", 2791 "required":[ 2792 "Period", 2793 "PeriodType" 2794 ], 2795 "members":{ 2796 "Period":{ 2797 "shape":"ValidityPeriodPeriodLong", 2798 "documentation":"<p>The numeric value for the validity period.</p>" 2799 }, 2800 "PeriodType":{ 2801 "shape":"ValidityPeriodType", 2802 "documentation":"<p>The unit of time. You can select hours, days, weeks, months, and years.</p>" 2803 } 2804 }, 2805 "documentation":"<p>Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate. Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in hours, days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value. </p>" 2806 }, 2807 "ValidityPeriodPeriodLong":{ 2808 "type":"long", 2809 "box":true, 2810 "max":8766000, 2811 "min":1 2812 }, 2813 "ValidityPeriodType":{ 2814 "type":"string", 2815 "enum":[ 2816 "HOURS", 2817 "DAYS", 2818 "WEEKS", 2819 "MONTHS", 2820 "YEARS" 2821 ] 2822 }, 2823 "VpcInformation":{ 2824 "type":"structure", 2825 "required":["SecurityGroupIds"], 2826 "members":{ 2827 "SecurityGroupIds":{ 2828 "shape":"SecurityGroupIdList", 2829 "documentation":"<p>The security groups used with the connector. You can use a maximum of 4 security groups with a connector.</p>" 2830 } 2831 }, 2832 "documentation":"<p>Information about your VPC and security groups used with the connector.</p>" 2833 } 2834 }, 2835 "documentation":"<p>Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to provision security certificates for AD signed by a private CA that you own. For more information, see <a href=\"https://docs.aws.amazon.com/privateca/latest/userguide/ad-connector.html\">Amazon Web Services Private CA Connector for Active Directory</a>.</p>" 2836} 2837