{ "smithy": "2.0", "shapes": { "com.amazonaws.pcaconnectorad#AccessControlEntry": { "type": "structure", "members": { "GroupDisplayName": { "target": "com.amazonaws.pcaconnectorad#DisplayName", "traits": { "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

" } }, "AccessRights": { "target": "com.amazonaws.pcaconnectorad#AccessRights", "traits": { "smithy.api#documentation": "

Permissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued\n against a template.

" } }, "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the Access Control Entry was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the Access Control Entry was updated.

" } } }, "traits": { "smithy.api#documentation": "

An access control entry allows or denies Active Directory groups based on their security\n identifiers (SIDs) from enrolling and/or autoenrolling with the template.

" } }, "com.amazonaws.pcaconnectorad#AccessControlEntryList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#AccessControlEntrySummary" } }, "com.amazonaws.pcaconnectorad#AccessControlEntrySummary": { "type": "structure", "members": { "GroupDisplayName": { "target": "com.amazonaws.pcaconnectorad#DisplayName", "traits": { "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

" } }, "AccessRights": { "target": "com.amazonaws.pcaconnectorad#AccessRights", "traits": { "smithy.api#documentation": "

Allow or deny an Active Directory group from enrolling and autoenrolling certificates issued against\n a template.

" } }, "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the Access Control Entry was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the Access Control Entry was updated.

" } } }, "traits": { "smithy.api#documentation": "

Summary of group access control entries that allow or deny Active Directory groups based on their\n security identifiers (SIDs) from enrolling and/or autofenrolling with the template.

" } }, "com.amazonaws.pcaconnectorad#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You can receive this error if you attempt to create a resource share when you don't have\n the required permissions. This can be caused by insufficient permissions in policies\n attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen\n because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)\n that affects your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.pcaconnectorad#AccessRight": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENY" } } } }, "com.amazonaws.pcaconnectorad#AccessRights": { "type": "structure", "members": { "Enroll": { "target": "com.amazonaws.pcaconnectorad#AccessRight", "traits": { "smithy.api#documentation": "

Allow or deny an Active Directory group from enrolling certificates issued against a\n template.

" } }, "AutoEnroll": { "target": "com.amazonaws.pcaconnectorad#AccessRight", "traits": { "smithy.api#documentation": "

Allow or deny an Active Directory group from autoenrolling certificates issued against a template.\n The Active Directory group must be allowed to enroll to allow autoenrollment

" } } }, "traits": { "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

" } }, "com.amazonaws.pcaconnectorad#ApplicationPolicies": { "type": "structure", "members": { "Critical": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Marks the application policy extension as critical.

" } }, "Policies": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicyList", "traits": { "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

" } }, "com.amazonaws.pcaconnectorad#ApplicationPolicy": { "type": "union", "members": { "PolicyType": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicyType", "traits": { "smithy.api#documentation": "

The type of application policy

" } }, "PolicyObjectIdentifier": { "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", "traits": { "smithy.api#documentation": "

The object identifier (OID) of an application policy.

" } } }, "traits": { "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

" } }, "com.amazonaws.pcaconnectorad#ApplicationPolicyList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicy" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.pcaconnectorad#ApplicationPolicyType": { "type": "enum", "members": { "ALL_APPLICATION_POLICIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL_APPLICATION_POLICIES" } }, "ANY_PURPOSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY_PURPOSE" } }, "ATTESTATION_IDENTITY_KEY_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ATTESTATION_IDENTITY_KEY_CERTIFICATE" } }, "CERTIFICATE_REQUEST_AGENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CERTIFICATE_REQUEST_AGENT" } }, "CLIENT_AUTHENTICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLIENT_AUTHENTICATION" } }, "CODE_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CODE_SIGNING" } }, "CTL_USAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CTL_USAGE" } }, "DIGITAL_RIGHTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIGITAL_RIGHTS" } }, "DIRECTORY_SERVICE_EMAIL_REPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_SERVICE_EMAIL_REPLICATION" } }, "DISALLOWED_LIST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISALLOWED_LIST" } }, "DNS_SERVER_TRUST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DNS_SERVER_TRUST" } }, "DOCUMENT_ENCRYPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOCUMENT_ENCRYPTION" } }, "DOCUMENT_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOCUMENT_SIGNING" } }, "DYNAMIC_CODE_GENERATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DYNAMIC_CODE_GENERATOR" } }, "EARLY_LAUNCH_ANTIMALWARE_DRIVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EARLY_LAUNCH_ANTIMALWARE_DRIVER" } }, "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION" } }, "ENCLAVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENCLAVE" } }, "ENCRYPTING_FILE_SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENCRYPTING_FILE_SYSTEM" } }, "ENDORSEMENT_KEY_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENDORSEMENT_KEY_CERTIFICATE" } }, "FILE_RECOVERY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FILE_RECOVERY" } }, "HAL_EXTENSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HAL_EXTENSION" } }, "IP_SECURITY_END_SYSTEM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IP_SECURITY_END_SYSTEM" } }, "IP_SECURITY_IKE_INTERMEDIATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IP_SECURITY_IKE_INTERMEDIATE" } }, "IP_SECURITY_TUNNEL_TERMINATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IP_SECURITY_TUNNEL_TERMINATION" } }, "IP_SECURITY_USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IP_SECURITY_USER" } }, "ISOLATED_USER_MODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISOLATED_USER_MODE" } }, "KDC_AUTHENTICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KDC_AUTHENTICATION" } }, "KERNEL_MODE_CODE_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KERNEL_MODE_CODE_SIGNING" } }, "KEY_PACK_LICENSES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEY_PACK_LICENSES" } }, "KEY_RECOVERY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEY_RECOVERY" } }, "KEY_RECOVERY_AGENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEY_RECOVERY_AGENT" } }, "LICENSE_SERVER_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LICENSE_SERVER_VERIFICATION" } }, "LIFETIME_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LIFETIME_SIGNING" } }, "MICROSOFT_PUBLISHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MICROSOFT_PUBLISHER" } }, "MICROSOFT_TIME_STAMPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MICROSOFT_TIME_STAMPING" } }, "MICROSOFT_TRUST_LIST_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MICROSOFT_TRUST_LIST_SIGNING" } }, "OCSP_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OCSP_SIGNING" } }, "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION" } }, "PLATFORM_CERTIFICATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PLATFORM_CERTIFICATE" } }, "PREVIEW_BUILD_SIGNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREVIEW_BUILD_SIGNING" } }, "PRIVATE_KEY_ARCHIVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATE_KEY_ARCHIVAL" } }, "PROTECTED_PROCESS_LIGHT_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROTECTED_PROCESS_LIGHT_VERIFICATION" } }, "PROTECTED_PROCESS_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROTECTED_PROCESS_VERIFICATION" } }, "QUALIFIED_SUBORDINATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUALIFIED_SUBORDINATION" } }, "REVOKED_LIST_SIGNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKED_LIST_SIGNER" } }, "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION" } }, "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION" } }, "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL" } }, "ROOT_LIST_SIGNER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT_LIST_SIGNER" } }, "SECURE_EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURE_EMAIL" } }, "SERVER_AUTHENTICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVER_AUTHENTICATION" } }, "SMART_CARD_LOGIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMART_CARD_LOGIN" } }, "SPC_ENCRYPTED_DIGEST_RETRY_COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPC_ENCRYPTED_DIGEST_RETRY_COUNT" } }, "SPC_RELAXED_PE_MARKER_CHECK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPC_RELAXED_PE_MARKER_CHECK" } }, "TIME_STAMPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIME_STAMPING" } }, "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION" } }, "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION" } }, "WINDOWS_HARDWARE_DRIVER_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_VERIFICATION" } }, "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION" } }, "WINDOWS_KITS_COMPONENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_KITS_COMPONENT" } }, "WINDOWS_RT_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_RT_VERIFICATION" } }, "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION" } }, "WINDOWS_STORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_STORE" } }, "WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SYSTEM_COMPONENT_VERIFICATION" } }, "WINDOWS_TCB_COMPONENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_TCB_COMPONENT" } }, "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT" } }, "WINDOWS_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_UPDATE" } } } }, "com.amazonaws.pcaconnectorad#CertificateAuthorityArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 200 }, "smithy.api#pattern": "^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" } }, "com.amazonaws.pcaconnectorad#CertificateValidity": { "type": "structure", "members": { "ValidityPeriod": { "target": "com.amazonaws.pcaconnectorad#ValidityPeriod", "traits": { "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in days, months,\n or years. For more information, see Validity in RFC 5280. This value is unaffected when\n ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

", "smithy.api#required": {} } }, "RenewalPeriod": { "target": "com.amazonaws.pcaconnectorad#ValidityPeriod", "traits": { "smithy.api#documentation": "

Renewal period is the period of time before certificate expiration when a new\n certificate will be requested.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in days, months,\n or years. For more information, see Validity in RFC 5280. This value is unaffected when\n ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

" } }, "com.amazonaws.pcaconnectorad#ClientCompatibilityV2": { "type": "enum", "members": { "WINDOWS_SERVER_2003": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2003" } }, "WINDOWS_SERVER_2008": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2008" } }, "WINDOWS_SERVER_2008_R2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2008_R2" } }, "WINDOWS_SERVER_2012": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012" } }, "WINDOWS_SERVER_2012_R2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" } }, "WINDOWS_SERVER_2016": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2016" } } } }, "com.amazonaws.pcaconnectorad#ClientCompatibilityV3": { "type": "enum", "members": { "WINDOWS_SERVER_2008": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2008" } }, "WINDOWS_SERVER_2008_R2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2008_R2" } }, "WINDOWS_SERVER_2012": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012" } }, "WINDOWS_SERVER_2012_R2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" } }, "WINDOWS_SERVER_2016": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2016" } } } }, "com.amazonaws.pcaconnectorad#ClientCompatibilityV4": { "type": "enum", "members": { "WINDOWS_SERVER_2012": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012" } }, "WINDOWS_SERVER_2012_R2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" } }, "WINDOWS_SERVER_2016": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WINDOWS_SERVER_2016" } } } }, "com.amazonaws.pcaconnectorad#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.pcaconnectorad#ConflictException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

This request cannot be completed for one of the following reasons because the requested\n resource was being concurrently modified by another request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.pcaconnectorad#Connector": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" } }, "CertificateAuthorityArn": { "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

" } }, "CertificateEnrollmentPolicyServerEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when\n requesting certificates.

" } }, "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

" } }, "VpcInformation": { "target": "com.amazonaws.pcaconnectorad#VpcInformation", "traits": { "smithy.api#documentation": "

Information of the VPC and security group(s) used with the connector.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#ConnectorStatus", "traits": { "smithy.api#documentation": "

Status of the connector. Status can be creating, active, deleting, or failed.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#ConnectorStatusReason", "traits": { "smithy.api#documentation": "

Additional information about the connector status if the status is failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the connector was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the connector was updated.

" } } }, "traits": { "smithy.api#documentation": "

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\n exchange of certificates from Amazon Web Services Private CA to domain-joined users and machines managed with\n Active Directory.

" } }, "com.amazonaws.pcaconnectorad#ConnectorArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 200 }, "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" } }, "com.amazonaws.pcaconnectorad#ConnectorList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#ConnectorSummary" } }, "com.amazonaws.pcaconnectorad#ConnectorResource": { "type": "resource", "identifiers": { "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn" } }, "create": { "target": "com.amazonaws.pcaconnectorad#CreateConnector" }, "read": { "target": "com.amazonaws.pcaconnectorad#GetConnector" }, "delete": { "target": "com.amazonaws.pcaconnectorad#DeleteConnector" }, "list": { "target": "com.amazonaws.pcaconnectorad#ListConnectors" }, "traits": { "aws.cloudformation#cfnResource": { "name": "Connector" } } }, "com.amazonaws.pcaconnectorad#ConnectorStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.pcaconnectorad#ConnectorStatusReason": { "type": "enum", "members": { "CA_CERTIFICATE_REGISTRATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CA_CERTIFICATE_REGISTRATION_FAILED" } }, "DIRECTORY_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" } }, "INTERNAL_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_FAILURE" } }, "INSUFFICIENT_FREE_ADDRESSES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSUFFICIENT_FREE_ADDRESSES" } }, "INVALID_SUBNET_IP_PROTOCOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SUBNET_IP_PROTOCOL" } }, "PRIVATECA_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATECA_ACCESS_DENIED" } }, "PRIVATECA_RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIVATECA_RESOURCE_NOT_FOUND" } }, "SECURITY_GROUP_NOT_IN_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITY_GROUP_NOT_IN_VPC" } }, "VPC_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC_ACCESS_DENIED" } }, "VPC_ENDPOINT_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC_ENDPOINT_LIMIT_EXCEEDED" } }, "VPC_RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC_RESOURCE_NOT_FOUND" } } } }, "com.amazonaws.pcaconnectorad#ConnectorSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" } }, "CertificateAuthorityArn": { "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

" } }, "CertificateEnrollmentPolicyServerEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Certificate enrollment endpoint for Active Directory domain-joined objects to request\n certificates.

" } }, "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

" } }, "VpcInformation": { "target": "com.amazonaws.pcaconnectorad#VpcInformation", "traits": { "smithy.api#documentation": "

Information of the VPC and security group(s) used with the connector.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#ConnectorStatus", "traits": { "smithy.api#documentation": "

Status of the connector. Status can be creating, active, deleting, or failed.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#ConnectorStatusReason", "traits": { "smithy.api#documentation": "

Additional information about the connector status if the status is failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the connector was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the connector was updated.

" } } }, "traits": { "smithy.api#documentation": "

Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services\n account.

" } }, "com.amazonaws.pcaconnectorad#CreateConnector": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#CreateConnectorRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#CreateConnectorResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA,\n directory ID, and security groups.

", "smithy.api#http": { "code": 202, "method": "POST", "uri": "/connectors" } } }, "com.amazonaws.pcaconnectorad#CreateConnectorRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

", "smithy.api#required": {} } }, "CertificateAuthorityArn": { "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

", "smithy.api#required": {} } }, "VpcInformation": { "target": "com.amazonaws.pcaconnectorad#VpcInformation", "traits": { "smithy.api#documentation": "

Information about your VPC and security groups used with the connector.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pcaconnectorad#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token.

", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.pcaconnectorad#Tags", "traits": { "aws.cloudformation#cfnMutability": "write", "smithy.api#documentation": "

Metadata assigned to a connector consisting of a key-value pair.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#CreateConnectorResponse": { "type": "structure", "members": { "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the connector for Active Directory.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#CreateDirectoryRegistration": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an\n Active Directory

", "smithy.api#http": { "code": 202, "method": "POST", "uri": "/directoryRegistrations" } } }, "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationRequest": { "type": "structure", "members": { "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pcaconnectorad#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token.

", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.pcaconnectorad#Tags", "traits": { "aws.cloudformation#cfnMutability": "write", "smithy.api#documentation": "

Metadata assigned to a directory registration consisting of a key-value pair.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationResponse": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#CreateServicePrincipalName": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#CreateServicePrincipalNameRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos\n authentication uses SPNs to associate a service instance with a service sign-in\n account.

", "smithy.api#http": { "code": 202, "method": "POST", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#CreateServicePrincipalNameRequest": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pcaconnectorad#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#CreateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#CreateTemplateRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#CreateTemplateResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an Active Directory compatible certificate template. The connectors issues certificates\n using these templates based on the requester\u2019s Active Directory group membership.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/templates" } } }, "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntry": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntryRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or\n autoenrolling with the template based on the group security identifiers (SIDs).

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/templates/{TemplateArn}/accessControlEntries" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntryRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", "smithy.api#required": {} } }, "GroupDisplayName": { "target": "com.amazonaws.pcaconnectorad#DisplayName", "traits": { "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

", "smithy.api#required": {} } }, "AccessRights": { "target": "com.amazonaws.pcaconnectorad#AccessRights", "traits": { "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pcaconnectorad#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#CreateTemplateRequest": { "type": "structure", "members": { "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.pcaconnectorad#TemplateName", "traits": { "smithy.api#documentation": "

Name of the template. The template name must be unique.

", "smithy.api#required": {} } }, "Definition": { "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pcaconnectorad#ClientToken", "traits": { "smithy.api#documentation": "

Idempotency token.

", "smithy.api#idempotencyToken": {} } }, "Tags": { "target": "com.amazonaws.pcaconnectorad#Tags", "traits": { "aws.cloudformation#cfnMutability": "write", "smithy.api#documentation": "

Metadata assigned to a template consisting of a key-value pair.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#CreateTemplateResponse": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the template.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#CryptoProvidersList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.pcaconnectorad#CustomObjectIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$" } }, "com.amazonaws.pcaconnectorad#DeleteConnector": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#DeleteConnectorRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the\n connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors\n action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can\n deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration\n action.

", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/connectors/{ConnectorArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#DeleteConnectorRequest": { "type": "structure", "members": { "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistration": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistrationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a directory registration. Deleting a directory registration deauthorizes\n Amazon Web Services Private CA with the directory.

", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistrationRequest": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#DeleteServicePrincipalName": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#DeleteServicePrincipalNameRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes the service principal name (SPN) used by a connector to authenticate with your\n Active Directory.

", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#DeleteServicePrincipalNameRequest": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#DeleteTemplate": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#DeleteTemplateRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a template. Certificates issued using the template are still valid until they\n are revoked or expired.

", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/templates/{TemplateArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntry": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntryRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a group access control entry.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntryRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#DeleteTemplateRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#DirectoryId": { "type": "string", "traits": { "smithy.api#pattern": "^d-[0-9a-f]{10}$" } }, "com.amazonaws.pcaconnectorad#DirectoryRegistration": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called\n CreateDirectoryRegistration.

" } }, "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus", "traits": { "smithy.api#documentation": "

Status of the directory registration.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason", "traits": { "smithy.api#documentation": "

Additional information about the directory registration status if the status is\n failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the directory registration was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the directory registration was updated.

" } } }, "traits": { "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with a\n directory.

" } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 200 }, "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration\\/d-[0-9a-f]{10}$" } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationSummary" } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationResource": { "type": "resource", "identifiers": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn" } }, "create": { "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistration" }, "read": { "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistration" }, "delete": { "target": "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistration" }, "list": { "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrations" }, "traits": { "aws.cloudformation#cfnResource": { "name": "DirectoryRegistration" } } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason": { "type": "enum", "members": { "DIRECTORY_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" } }, "DIRECTORY_RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_RESOURCE_NOT_FOUND" } }, "DIRECTORY_NOT_ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_NOT_ACTIVE" } }, "DIRECTORY_NOT_REACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_NOT_REACHABLE" } }, "DIRECTORY_TYPE_NOT_SUPPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_TYPE_NOT_SUPPORTED" } }, "INTERNAL_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_FAILURE" } } } }, "com.amazonaws.pcaconnectorad#DirectoryRegistrationSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" } }, "DirectoryId": { "target": "com.amazonaws.pcaconnectorad#DirectoryId", "traits": { "smithy.api#documentation": "

The identifier of the Active Directory.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus", "traits": { "smithy.api#documentation": "

Status of the directory registration.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason", "traits": { "smithy.api#documentation": "

Additional information about the directory registration status if the status is\n failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the directory registration was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the directory registration was updated.

" } } }, "traits": { "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with\n the Active Directory.

" } }, "com.amazonaws.pcaconnectorad#DisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\x20-\\x7E]+$" } }, "com.amazonaws.pcaconnectorad#EnrollmentFlagsV2": { "type": "structure", "members": { "IncludeSymmetricAlgorithms": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" } }, "UserInteractionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" } }, "RemoveInvalidCertificateFromPersonalStore": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" } }, "NoSecurityExtension": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" } }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allow renewal using the same key.

" } } }, "traits": { "smithy.api#documentation": "

Template configurations for v2 template schema.

" } }, "com.amazonaws.pcaconnectorad#EnrollmentFlagsV3": { "type": "structure", "members": { "IncludeSymmetricAlgorithms": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" } }, "UserInteractionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" } }, "RemoveInvalidCertificateFromPersonalStore": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" } }, "NoSecurityExtension": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" } }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allow renewal using the same key.

" } } }, "traits": { "smithy.api#documentation": "

Template configurations for v3 template schema.

" } }, "com.amazonaws.pcaconnectorad#EnrollmentFlagsV4": { "type": "structure", "members": { "IncludeSymmetricAlgorithms": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" } }, "UserInteractionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" } }, "RemoveInvalidCertificateFromPersonalStore": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" } }, "NoSecurityExtension": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" } }, "EnableKeyReuseOnNtTokenKeysetStorageFull": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allow renewal using the same key.

" } } }, "traits": { "smithy.api#documentation": "

Template configurations for v4 template schema.

" } }, "com.amazonaws.pcaconnectorad#ExtensionsV2": { "type": "structure", "members": { "KeyUsage": { "target": "com.amazonaws.pcaconnectorad#KeyUsage", "traits": { "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature, certificate\n signing) of the key contained in the certificate.

", "smithy.api#required": {} } }, "ApplicationPolicies": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", "traits": { "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" } } }, "traits": { "smithy.api#documentation": "

Certificate extensions for v2 template schema

" } }, "com.amazonaws.pcaconnectorad#ExtensionsV3": { "type": "structure", "members": { "KeyUsage": { "target": "com.amazonaws.pcaconnectorad#KeyUsage", "traits": { "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature, certificate\n signing) of the key contained in the certificate.

", "smithy.api#required": {} } }, "ApplicationPolicies": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", "traits": { "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" } } }, "traits": { "smithy.api#documentation": "

Certificate extensions for v3 template schema

" } }, "com.amazonaws.pcaconnectorad#ExtensionsV4": { "type": "structure", "members": { "KeyUsage": { "target": "com.amazonaws.pcaconnectorad#KeyUsage", "traits": { "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

", "smithy.api#required": {} } }, "ApplicationPolicies": { "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", "traits": { "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" } } }, "traits": { "smithy.api#documentation": "

Certificate extensions for v4 template schema

" } }, "com.amazonaws.pcaconnectorad#GeneralFlagsV2": { "type": "structure", "members": { "AutoEnrollment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" } }, "MachineType": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users.

" } } }, "traits": { "smithy.api#documentation": "

General flags for v2 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" } }, "com.amazonaws.pcaconnectorad#GeneralFlagsV3": { "type": "structure", "members": { "AutoEnrollment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" } }, "MachineType": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users

" } } }, "traits": { "smithy.api#documentation": "

General flags for v3 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" } }, "com.amazonaws.pcaconnectorad#GeneralFlagsV4": { "type": "structure", "members": { "AutoEnrollment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" } }, "MachineType": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users

" } } }, "traits": { "smithy.api#documentation": "

General flags for v4 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" } }, "com.amazonaws.pcaconnectorad#GetConnector": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#GetConnectorRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#GetConnectorResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists information about your connector. You specify the connector on input by its ARN\n (Amazon Resource Name).

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/connectors/{ConnectorArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#GetConnectorRequest": { "type": "structure", "members": { "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#GetConnectorResponse": { "type": "structure", "members": { "Connector": { "target": "com.amazonaws.pcaconnectorad#Connector", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A structure that contains information about your connector.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#GetDirectoryRegistration": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

A structure that contains information about your directory registration.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationRequest": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationResponse": { "type": "structure", "members": { "DirectoryRegistration": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistration", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with a\n directory.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#GetServicePrincipalName": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalNameRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalNameResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the service principal name that the connector uses to authenticate with\n Active Directory.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#GetServicePrincipalNameRequest": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#GetServicePrincipalNameResponse": { "type": "structure", "members": { "ServicePrincipalName": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalName", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#GetTemplate": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#GetTemplateRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#GetTemplateResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves a certificate template that the connector uses to issue certificates from a\n private CA.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/templates/{TemplateArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntry": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the group access control entries for a template.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryResponse": { "type": "structure", "members": { "AccessControlEntry": { "target": "com.amazonaws.pcaconnectorad#AccessControlEntry", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

An access control entry allows or denies an Active Directory group from enrolling and/or\n autoenrolling with a template.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#GetTemplateRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#GetTemplateResponse": { "type": "structure", "members": { "Template": { "target": "com.amazonaws.pcaconnectorad#Template", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "

A certificate template that the connector uses to issue certificates from a private\n CA.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 256 }, "smithy.api#pattern": "^S-[0-9]-([0-9]+-){1,14}[0-9]+$" } }, "com.amazonaws.pcaconnectorad#HashAlgorithm": { "type": "enum", "members": { "SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA256" } }, "SHA384": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA384" } }, "SHA512": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA512" } } } }, "com.amazonaws.pcaconnectorad#InternalServerException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure with\n an internal server.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.pcaconnectorad#IpAddressType": { "type": "enum", "members": { "IPV4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IPV4" } }, "DUALSTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUALSTACK" } } } }, "com.amazonaws.pcaconnectorad#KeySpec": { "type": "enum", "members": { "KEY_EXCHANGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEY_EXCHANGE" } }, "SIGNATURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIGNATURE" } } } }, "com.amazonaws.pcaconnectorad#KeyUsage": { "type": "structure", "members": { "Critical": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Sets the key usage extension to critical.

" } }, "UsageFlags": { "target": "com.amazonaws.pcaconnectorad#KeyUsageFlags", "traits": { "smithy.api#documentation": "

The key usage flags represent the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

" } }, "com.amazonaws.pcaconnectorad#KeyUsageFlags": { "type": "structure", "members": { "DigitalSignature": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

The digitalSignature is asserted when the subject public key is used for verifying\n digital signatures.

" } }, "NonRepudiation": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

NonRepudiation is asserted when the subject public key is used to verify digital\n signatures.

" } }, "KeyEncipherment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

KeyEncipherment is asserted when the subject public key is used for enciphering private\n or secret keys, i.e., for key transport.

" } }, "DataEncipherment": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

DataEncipherment is asserted when the subject public key is used for directly\n enciphering raw user data without the use of an intermediate symmetric cipher.

" } }, "KeyAgreement": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

KeyAgreement is asserted when the subject public key is used for key agreement.

" } } }, "traits": { "smithy.api#documentation": "

The key usage flags represent the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

" } }, "com.amazonaws.pcaconnectorad#KeyUsageProperty": { "type": "union", "members": { "PropertyType": { "target": "com.amazonaws.pcaconnectorad#KeyUsagePropertyType", "traits": { "smithy.api#documentation": "

You can specify all key usages using property type ALL. You can use property type or\n property flags but not both.

" } }, "PropertyFlags": { "target": "com.amazonaws.pcaconnectorad#KeyUsagePropertyFlags", "traits": { "smithy.api#documentation": "

You can specify key usage for encryption, key agreement, and signature. You can use\n property flags or property type but not both.

" } } }, "traits": { "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

" } }, "com.amazonaws.pcaconnectorad#KeyUsagePropertyFlags": { "type": "structure", "members": { "Decrypt": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows key for encryption and decryption.

" } }, "KeyAgreement": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows key exchange without encryption.

" } }, "Sign": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allow key use for digital signature.

" } } }, "traits": { "smithy.api#documentation": "

Specifies key usage.

" } }, "com.amazonaws.pcaconnectorad#KeyUsagePropertyType": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.pcaconnectorad#ListConnectors": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListConnectorsRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListConnectorsResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/connectors" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Connectors" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListConnectorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.pcaconnectorad#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListConnectorsResponse": { "type": "structure", "members": { "Connectors": { "target": "com.amazonaws.pcaconnectorad#ConnectorList", "traits": { "smithy.api#documentation": "

Summary information about each connector you have created.

" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken parameter from the\n response you just received.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#ListDirectoryRegistrations": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration\n action.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/directoryRegistrations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "DirectoryRegistrations" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.pcaconnectorad#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", "smithy.api#httpQuery": "NextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsResponse": { "type": "structure", "members": { "DirectoryRegistrations": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationList", "traits": { "smithy.api#documentation": "

Summary information about each directory registration you have created.

" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#ListServicePrincipalNames": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the service principal names that the connector uses to authenticate with\n Active Directory.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "ServicePrincipalNames" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.pcaconnectorad#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", "smithy.api#httpQuery": "NextToken" } }, "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesResponse": { "type": "structure", "members": { "ServicePrincipalNames": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameList", "traits": { "smithy.api#documentation": "

The service principal name, if any, that the connector uses to authenticate with\n Active Directory.

" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the tags, if any, that are associated with your resource.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/tags/{ResourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.pcaconnectorad#Tags", "traits": { "smithy.api#documentation": "

The tags, if any, that are associated with your resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntries": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists group access control entries you created.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/templates/{TemplateArn}/accessControlEntries" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "AccessControlEntries" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.pcaconnectorad#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", "smithy.api#httpQuery": "NextToken" } }, "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesResponse": { "type": "structure", "members": { "AccessControlEntries": { "target": "com.amazonaws.pcaconnectorad#AccessControlEntryList", "traits": { "smithy.api#documentation": "

An access control entry grants or denies permission to an Active Directory group to enroll\n certificates for a template.

" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#ListTemplates": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#ListTemplatesRequest" }, "output": { "target": "com.amazonaws.pcaconnectorad#ListTemplatesResponse" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the templates, if any, that are associated with a connector.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/templates" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "Templates" }, "smithy.api#readonly": {} } }, "com.amazonaws.pcaconnectorad#ListTemplatesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.pcaconnectorad#MaxResults", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", "smithy.api#httpQuery": "NextToken" } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", "smithy.api#httpQuery": "ConnectorArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ListTemplatesResponse": { "type": "structure", "members": { "Templates": { "target": "com.amazonaws.pcaconnectorad#TemplateList", "traits": { "smithy.api#documentation": "

Custom configuration templates used when issuing a certificate.

" } }, "NextToken": { "target": "com.amazonaws.pcaconnectorad#NextToken", "traits": { "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.pcaconnectorad#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.pcaconnectorad#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:[A-Za-z0-9_-]{4})*(?:[A-Za-z0-9_-]{2}==|[A-Za-z0-9_-]{3}=)?$" } }, "com.amazonaws.pcaconnectorad#PcaConnectorAd": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.pcaconnectorad#ListTagsForResource" }, { "target": "com.amazonaws.pcaconnectorad#TagResource" }, { "target": "com.amazonaws.pcaconnectorad#UntagResource" } ], "resources": [ { "target": "com.amazonaws.pcaconnectorad#ConnectorResource" }, { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationResource" }, { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameResource" }, { "target": "com.amazonaws.pcaconnectorad#TemplateGroupAccessControlEntryResource" }, { "target": "com.amazonaws.pcaconnectorad#TemplateResource" } ], "traits": { "aws.api#service": { "arnNamespace": "pca-connector-ad", "cloudFormationName": "PCAConnectorAD", "sdkId": "Pca Connector Ad", "serviceName": "pca-connector-ad", "cloudTrailEventSource": "pca-connector-ad.amazonaws.com" }, "aws.auth#sigv4": { "name": "pca-connector-ad" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id" ], "maxAge": 86400 }, "smithy.api#documentation": "

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\n provision security certificates for AD signed by a private CA that you own. For more\n information, see Amazon Web Services Private CA Connector for Active Directory.

", "smithy.api#title": "PcaConnectorAd", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://pca-connector-ad.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://pca-connector-ad.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://pca-connector-ad.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://pca-connector-ad.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://pca-connector-ad.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm": { "type": "enum", "members": { "RSA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RSA" } }, "ECDH_P256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECDH_P256" } }, "ECDH_P384": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECDH_P384" } }, "ECDH_P521": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ECDH_P521" } } } }, "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV2": { "type": "structure", "members": { "MinimalKeyLength": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Set the minimum key length of the private key.

", "smithy.api#range": { "min": 1 }, "smithy.api#required": {} } }, "KeySpec": { "target": "com.amazonaws.pcaconnectorad#KeySpec", "traits": { "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", "smithy.api#required": {} } }, "CryptoProviders": { "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", "traits": { "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" } } }, "traits": { "smithy.api#documentation": "

Defines the attributes of the private key.

" } }, "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV3": { "type": "structure", "members": { "MinimalKeyLength": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Set the minimum key length of the private key.

", "smithy.api#range": { "min": 1 }, "smithy.api#required": {} } }, "KeySpec": { "target": "com.amazonaws.pcaconnectorad#KeySpec", "traits": { "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", "smithy.api#required": {} } }, "CryptoProviders": { "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", "traits": { "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" } }, "KeyUsageProperty": { "target": "com.amazonaws.pcaconnectorad#KeyUsageProperty", "traits": { "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

", "smithy.api#required": {} } }, "Algorithm": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm", "traits": { "smithy.api#documentation": "

Defines the algorithm used to generate the private key.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the attributes of the private key.

" } }, "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV4": { "type": "structure", "members": { "MinimalKeyLength": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

Set the minimum key length of the private key.

", "smithy.api#range": { "min": 1 }, "smithy.api#required": {} } }, "KeySpec": { "target": "com.amazonaws.pcaconnectorad#KeySpec", "traits": { "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", "smithy.api#required": {} } }, "CryptoProviders": { "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", "traits": { "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" } }, "KeyUsageProperty": { "target": "com.amazonaws.pcaconnectorad#KeyUsageProperty", "traits": { "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

" } }, "Algorithm": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm", "traits": { "smithy.api#documentation": "

Defines the algorithm used to generate the private key.

" } } }, "traits": { "smithy.api#documentation": "

Defines the attributes of the private key.

" } }, "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV2": { "type": "structure", "members": { "ExportableKey": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows the private key to be exported.

" } }, "StrongKeyProtectionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Require user input when using the private key for enrollment.

" } }, "ClientVersion": { "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV2", "traits": { "smithy.api#documentation": "

Defines the minimum client compatibility.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Private key flags for v2 templates specify the client compatibility, if the private key\n can be exported, and if user input is required when using a private key.

" } }, "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV3": { "type": "structure", "members": { "ExportableKey": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows the private key to be exported.

" } }, "StrongKeyProtectionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Requirer user input when using the private key for enrollment.

" } }, "RequireAlternateSignatureAlgorithm": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Reguires the PKCS #1 v2.1 signature format for certificates. You should verify that your\n CA, objects, and applications can accept this signature format.

" } }, "ClientVersion": { "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV3", "traits": { "smithy.api#documentation": "

Defines the minimum client compatibility.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Private key flags for v3 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, and if an alternate\n signature algorithm should be used.

" } }, "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV4": { "type": "structure", "members": { "ExportableKey": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Allows the private key to be exported.

" } }, "StrongKeyProtectionRequired": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Require user input when using the private key for enrollment.

" } }, "RequireAlternateSignatureAlgorithm": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your\n CA, objects, and applications can accept this signature format.

" } }, "RequireSameKeyRenewal": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Renew certificate using the same private key.

" } }, "UseLegacyProvider": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Specifies the cryptographic service provider category used to generate private keys. Set\n to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage\n Providers.

" } }, "ClientVersion": { "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV4", "traits": { "smithy.api#documentation": "

Defines the minimum client compatibility.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Private key flags for v4 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, if an alternate\n signature algorithm should be used, and if certificates are renewed using the same private\n key.

" } }, "com.amazonaws.pcaconnectorad#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The operation tried to access a nonexistent resource. The resource might not be\n specified correctly, or its status might not be ACTIVE.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.pcaconnectorad#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 11, "max": 20 }, "smithy.api#pattern": "^(?:sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" } }, "com.amazonaws.pcaconnectorad#SecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 4 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.pcaconnectorad#ServicePrincipalName": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.html.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus", "traits": { "smithy.api#documentation": "

The status of a service principal name.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason", "traits": { "smithy.api#documentation": "

Additional information for the status of a service principal name if the status is\n failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the service principal name was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the service principal name was updated.

" } } }, "traits": { "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" } }, "com.amazonaws.pcaconnectorad#ServicePrincipalNameList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameSummary" } }, "com.amazonaws.pcaconnectorad#ServicePrincipalNameResource": { "type": "resource", "identifiers": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn" }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn" } }, "put": { "target": "com.amazonaws.pcaconnectorad#CreateServicePrincipalName" }, "read": { "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalName" }, "delete": { "target": "com.amazonaws.pcaconnectorad#DeleteServicePrincipalName" }, "list": { "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNames" }, "traits": { "aws.cloudformation#cfnResource": { "name": "ServicePrincipalName" }, "smithy.api#noReplace": {} } }, "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason": { "type": "enum", "members": { "DIRECTORY_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" } }, "DIRECTORY_NOT_REACHABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_NOT_REACHABLE" } }, "DIRECTORY_RESOURCE_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DIRECTORY_RESOURCE_NOT_FOUND" } }, "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT" } }, "SPN_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SPN_LIMIT_EXCEEDED" } }, "INTERNAL_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_FAILURE" } } } }, "com.amazonaws.pcaconnectorad#ServicePrincipalNameSummary": { "type": "structure", "members": { "DirectoryRegistrationArn": { "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus", "traits": { "smithy.api#documentation": "

The status of a service principal name.

" } }, "StatusReason": { "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason", "traits": { "smithy.api#documentation": "

Additional information for the status of a service principal name if the status is\n failed.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the service principal name was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Time when the service principal name was updated.

" } } }, "traits": { "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" } }, "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", "smithy.api#required": {} } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", "smithy.api#required": {} } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifies the originating service.

", "smithy.api#required": {} } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The code associated with the service quota.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.pcaconnectorad#SubjectNameFlagsV2": { "type": "structure", "members": { "SanRequireDomainDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" } }, "SanRequireSpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" } }, "SanRequireDirectoryGuid": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" } }, "SanRequireUpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" } }, "SanRequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" } }, "SanRequireDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" } }, "RequireDnsAsCn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" } }, "RequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject name.

" } }, "RequireCommonName": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the common name in the subject name.

" } }, "RequireDirectoryPath": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the directory path in the subject name.

" } } }, "traits": { "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" } }, "com.amazonaws.pcaconnectorad#SubjectNameFlagsV3": { "type": "structure", "members": { "SanRequireDomainDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" } }, "SanRequireSpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" } }, "SanRequireDirectoryGuid": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" } }, "SanRequireUpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" } }, "SanRequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" } }, "SanRequireDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" } }, "RequireDnsAsCn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" } }, "RequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject name.

" } }, "RequireCommonName": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the common name in the subject name.

" } }, "RequireDirectoryPath": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the directory path in the subject name.

" } } }, "traits": { "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" } }, "com.amazonaws.pcaconnectorad#SubjectNameFlagsV4": { "type": "structure", "members": { "SanRequireDomainDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" } }, "SanRequireSpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" } }, "SanRequireDirectoryGuid": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" } }, "SanRequireUpn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" } }, "SanRequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" } }, "SanRequireDns": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" } }, "RequireDnsAsCn": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" } }, "RequireEmail": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the subject's email in the subject name.

" } }, "RequireCommonName": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the common name in the subject name.

" } }, "RequireDirectoryPath": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Include the directory path in the subject name.

" } } }, "traits": { "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" } }, "com.amazonaws.pcaconnectorad#TagKeyList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.pcaconnectorad#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds one or more tags to your resource.

", "smithy.api#http": { "code": 204, "method": "POST", "uri": "/tags/{ResourceArn}" } } }, "com.amazonaws.pcaconnectorad#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.pcaconnectorad#Tags", "traits": { "smithy.api#documentation": "

Metadata assigned to a directory registration consisting of a key-value pair.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#Tags": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.pcaconnectorad#Template": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" } }, "Definition": { "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "Name": { "target": "com.amazonaws.pcaconnectorad#TemplateName", "traits": { "smithy.api#documentation": "

Name of the templates. Template names must be unique.

" } }, "ObjectIdentifier": { "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", "traits": { "smithy.api#documentation": "

Object identifier of a template.

" } }, "PolicySchema": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The template schema version. Template schema versions can be v2, v3, or v4. The template\n configuration options change based on the template schema version.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#TemplateStatus", "traits": { "smithy.api#documentation": "

Status of the template. Status can be creating, active, deleting, or failed.

" } }, "Revision": { "target": "com.amazonaws.pcaconnectorad#TemplateRevision", "traits": { "smithy.api#documentation": "

The version of the template. Template updates will increment the minor revision.\n Re-enrolling all certificate holders will increment the major revision.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the template was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the template was updated.

" } } }, "traits": { "smithy.api#documentation": "

An Active Directory compatible certificate template. Connectors issue certificates against these\n templates based on the requestor's Active Directory group membership.

" } }, "com.amazonaws.pcaconnectorad#TemplateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 200 }, "smithy.api#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}$" } }, "com.amazonaws.pcaconnectorad#TemplateDefinition": { "type": "union", "members": { "TemplateV2": { "target": "com.amazonaws.pcaconnectorad#TemplateV2", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "TemplateV3": { "target": "com.amazonaws.pcaconnectorad#TemplateV3", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "TemplateV4": { "target": "com.amazonaws.pcaconnectorad#TemplateV4", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } } }, "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "com.amazonaws.pcaconnectorad#TemplateGroupAccessControlEntryResource": { "type": "resource", "identifiers": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn" }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier" } }, "put": { "target": "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntry" }, "read": { "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntry" }, "update": { "target": "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntry" }, "delete": { "target": "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntry" }, "list": { "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntries" }, "traits": { "aws.cloudformation#cfnResource": { "name": "TemplateGroupAccessControlEntry" } } }, "com.amazonaws.pcaconnectorad#TemplateList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#TemplateSummary" } }, "com.amazonaws.pcaconnectorad#TemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$" } }, "com.amazonaws.pcaconnectorad#TemplateNameList": { "type": "list", "member": { "target": "com.amazonaws.pcaconnectorad#TemplateName" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.pcaconnectorad#TemplateResource": { "type": "resource", "identifiers": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn" } }, "create": { "target": "com.amazonaws.pcaconnectorad#CreateTemplate" }, "read": { "target": "com.amazonaws.pcaconnectorad#GetTemplate" }, "update": { "target": "com.amazonaws.pcaconnectorad#UpdateTemplate" }, "delete": { "target": "com.amazonaws.pcaconnectorad#DeleteTemplate" }, "list": { "target": "com.amazonaws.pcaconnectorad#ListTemplates" }, "traits": { "aws.cloudformation#cfnResource": { "name": "Template" } } }, "com.amazonaws.pcaconnectorad#TemplateRevision": { "type": "structure", "members": { "MajorRevision": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The revision version of the template. Re-enrolling all certificate holders will\n increment the major revision.

", "smithy.api#required": {} } }, "MinorRevision": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The revision version of the template. Re-enrolling all certificate holders will\n increment the major revision.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The revision version of the template. Template updates will increment the minor\n revision. Re-enrolling all certificate holders will increment the major revision.

" } }, "com.amazonaws.pcaconnectorad#TemplateStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.pcaconnectorad#TemplateSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" } }, "ConnectorArn": { "target": "com.amazonaws.pcaconnectorad#ConnectorArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" } }, "Definition": { "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "Name": { "target": "com.amazonaws.pcaconnectorad#TemplateName", "traits": { "smithy.api#documentation": "

Name of the template. The template name must be unique.

" } }, "ObjectIdentifier": { "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", "traits": { "smithy.api#documentation": "

Object identifier of a template.

" } }, "PolicySchema": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The template schema version. Template schema versions can be v2, v3, or v4. The template\n configuration options change based on the template schema version.

" } }, "Status": { "target": "com.amazonaws.pcaconnectorad#TemplateStatus", "traits": { "smithy.api#documentation": "

Status of the template. Status can be creating, active, deleting, or failed.

" } }, "Revision": { "target": "com.amazonaws.pcaconnectorad#TemplateRevision", "traits": { "smithy.api#documentation": "

The revision version of the template. Template updates will increment the minor\n revision. Re-enrolling all certificate holders will increment the major revision.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the template was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the template was updated.

" } } }, "traits": { "smithy.api#documentation": "

An Active Directory compatible certificate template. Connectors issue certificates against these\n templates based on the requestor's Active Directory group membership.

" } }, "com.amazonaws.pcaconnectorad#TemplateV2": { "type": "structure", "members": { "CertificateValidity": { "target": "com.amazonaws.pcaconnectorad#CertificateValidity", "traits": { "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", "smithy.api#required": {} } }, "SupersededTemplates": { "target": "com.amazonaws.pcaconnectorad#TemplateNameList", "traits": { "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" } }, "PrivateKeyAttributes": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV2", "traits": { "smithy.api#documentation": "

Private key attributes allow you to specify the minimal key length, key spec, and\n cryptographic providers for the private key of a certificate for v2 templates. V2 templates\n allow you to use Legacy Cryptographic Service Providers.

", "smithy.api#required": {} } }, "PrivateKeyFlags": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV2", "traits": { "smithy.api#documentation": "

Private key flags for v2 templates specify the client compatibility, if the private key\n can be exported, and if user input is required when using a private key.

", "smithy.api#required": {} } }, "EnrollmentFlags": { "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV2", "traits": { "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates such as using the\n existing private key and deleting expired or revoked certificates.

", "smithy.api#required": {} } }, "SubjectNameFlags": { "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV2", "traits": { "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", "smithy.api#required": {} } }, "GeneralFlags": { "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV2", "traits": { "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", "smithy.api#required": {} } }, "Extensions": { "target": "com.amazonaws.pcaconnectorad#ExtensionsV2", "traits": { "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

v2 template schema that uses Legacy Cryptographic Providers.

" } }, "com.amazonaws.pcaconnectorad#TemplateV3": { "type": "structure", "members": { "CertificateValidity": { "target": "com.amazonaws.pcaconnectorad#CertificateValidity", "traits": { "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", "smithy.api#required": {} } }, "SupersededTemplates": { "target": "com.amazonaws.pcaconnectorad#TemplateNameList", "traits": { "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" } }, "PrivateKeyAttributes": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV3", "traits": { "smithy.api#documentation": "

Private key attributes allow you to specify the algorithm, minimal key length, key spec,\n key usage, and cryptographic providers for the private key of a certificate for v3\n templates. V3 templates allow you to use Key Storage Providers.

", "smithy.api#required": {} } }, "PrivateKeyFlags": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV3", "traits": { "smithy.api#documentation": "

Private key flags for v3 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, and if an alternate\n signature algorithm should be used.

", "smithy.api#required": {} } }, "EnrollmentFlags": { "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV3", "traits": { "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates such as using the\n existing private key and deleting expired or revoked certificates.

", "smithy.api#required": {} } }, "SubjectNameFlags": { "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV3", "traits": { "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", "smithy.api#required": {} } }, "GeneralFlags": { "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV3", "traits": { "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", "smithy.api#required": {} } }, "HashAlgorithm": { "target": "com.amazonaws.pcaconnectorad#HashAlgorithm", "traits": { "smithy.api#documentation": "

Specifies the hash algorithm used to hash the private key.

", "smithy.api#required": {} } }, "Extensions": { "target": "com.amazonaws.pcaconnectorad#ExtensionsV3", "traits": { "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

v3 template schema that uses Key Storage Providers.

" } }, "com.amazonaws.pcaconnectorad#TemplateV4": { "type": "structure", "members": { "CertificateValidity": { "target": "com.amazonaws.pcaconnectorad#CertificateValidity", "traits": { "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", "smithy.api#required": {} } }, "SupersededTemplates": { "target": "com.amazonaws.pcaconnectorad#TemplateNameList", "traits": { "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" } }, "PrivateKeyAttributes": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV4", "traits": { "smithy.api#documentation": "

Private key attributes allow you to specify the minimal key length, key spec, key usage,\n and cryptographic providers for the private key of a certificate for v4 templates. V4\n templates allow you to use either Key Storage Providers or Legacy Cryptographic Service\n Providers. You specify the cryptography provider category in private key flags.

", "smithy.api#required": {} } }, "PrivateKeyFlags": { "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV4", "traits": { "smithy.api#documentation": "

Private key flags for v4 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, if an alternate\n signature algorithm should be used, and if certificates are renewed using the same private\n key.

", "smithy.api#required": {} } }, "EnrollmentFlags": { "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV4", "traits": { "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates using the existing\n private key and deleting expired or revoked certificates.

", "smithy.api#required": {} } }, "SubjectNameFlags": { "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV4", "traits": { "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", "smithy.api#required": {} } }, "GeneralFlags": { "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV4", "traits": { "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", "smithy.api#required": {} } }, "HashAlgorithm": { "target": "com.amazonaws.pcaconnectorad#HashAlgorithm", "traits": { "smithy.api#documentation": "

Specifies the hash algorithm used to hash the private key. Hash algorithm can only be\n specified when using Key Storage Providers.

" } }, "Extensions": { "target": "com.amazonaws.pcaconnectorad#ExtensionsV4", "traits": { "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

v4 template schema that can use either Legacy Cryptographic Providers or Key Storage\n Providers.

" } }, "com.amazonaws.pcaconnectorad#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifies the originating service.

" } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The code associated with the quota.

" } } }, "traits": { "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.pcaconnectorad#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes one or more tags from your resource.

", "smithy.api#http": { "code": 204, "method": "DELETE", "uri": "/tags/{ResourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.pcaconnectorad#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.pcaconnectorad#TagKeyList", "traits": { "smithy.api#documentation": "

Specifies a list of tag keys that you want to remove from the specified\n resources.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#UpdateTemplate": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#UpdateTemplateRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update template configuration to define the information included in certificates.

", "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/templates/{TemplateArn}" } } }, "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntry": { "type": "operation", "input": { "target": "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntryRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" }, { "target": "com.amazonaws.pcaconnectorad#ConflictException" }, { "target": "com.amazonaws.pcaconnectorad#InternalServerException" }, { "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" }, { "target": "com.amazonaws.pcaconnectorad#ThrottlingException" }, { "target": "com.amazonaws.pcaconnectorad#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

", "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" } } }, "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntryRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupSecurityIdentifier": { "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", "traits": { "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "GroupDisplayName": { "target": "com.amazonaws.pcaconnectorad#DisplayName", "traits": { "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" } }, "AccessRights": { "target": "com.amazonaws.pcaconnectorad#AccessRights", "traits": { "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#UpdateTemplateRequest": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.pcaconnectorad#TemplateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Definition": { "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", "traits": { "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" } }, "ReenrollAllCertificateHolders": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

This setting allows the major version of a template to be increased automatically. All\n members of Active Directory groups that are allowed to enroll with a template will receive a new\n certificate issued using that template.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.pcaconnectorad#ValidationException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.pcaconnectorad#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason for the validation error. This won't be return for every\n validation exception.

" } } }, "traits": { "smithy.api#documentation": "

An input validation error occurred. For example, invalid characters in a template name,\n or if a pagination token is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.pcaconnectorad#ValidationExceptionReason": { "type": "enum", "members": { "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" } }, "INVALID_CA_SUBJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_CA_SUBJECT" } }, "INVALID_PERMISSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PERMISSION" } }, "INVALID_STATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_STATE" } }, "MISMATCHED_CONNECTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISMATCHED_CONNECTOR" } }, "MISMATCHED_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISMATCHED_VPC" } }, "NO_CLIENT_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_CLIENT_TOKEN" } }, "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_OPERATION" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } } }, "com.amazonaws.pcaconnectorad#ValidityPeriod": { "type": "structure", "members": { "PeriodType": { "target": "com.amazonaws.pcaconnectorad#ValidityPeriodType", "traits": { "smithy.api#documentation": "

The unit of time. You can select hours, days, weeks, months, and years.

", "smithy.api#required": {} } }, "Period": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

The numeric value for the validity period.

", "smithy.api#range": { "min": 1, "max": 8766000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the \u201cNot After\u201d date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in hours, days,\n months, or years. For more information, see Validity in RFC 5280. This value is unaffected\n when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

" } }, "com.amazonaws.pcaconnectorad#ValidityPeriodType": { "type": "enum", "members": { "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURS" } }, "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } }, "WEEKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEEKS" } }, "MONTHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONTHS" } }, "YEARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YEARS" } } } }, "com.amazonaws.pcaconnectorad#VpcInformation": { "type": "structure", "members": { "IpAddressType": { "target": "com.amazonaws.pcaconnectorad#IpAddressType", "traits": { "smithy.api#documentation": "

The VPC IP address type.

" } }, "SecurityGroupIds": { "target": "com.amazonaws.pcaconnectorad#SecurityGroupIdList", "traits": { "smithy.api#documentation": "

The security groups used with the connector. You can use a maximum of 4 security groups\n with a connector.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Information about your VPC and security groups used with the connector.

" } } } }