Skip to content

Commit 84d6332

Browse files
author
AWS
committed
AWS Directory Service Update: Add APIs for CA AutoEnrollment support: DescribeCAEnrollmentPolicy, EnableCAEnrollmentPolicy and DisableCAEnrollmentPolicy.
1 parent 79e6c5e commit 84d6332

File tree

2 files changed

+173
-0
lines changed

2 files changed

+173
-0
lines changed

‎.changes/next-release/feature-AWSDirectoryService-0bc44d4.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Directory Service",
4+
"contributor": "",
5+
"description": "Add APIs for CA AutoEnrollment support: DescribeCAEnrollmentPolicy, EnableCAEnrollmentPolicy and DisableCAEnrollmentPolicy."
6+
}

‎services/directory/src/main/resources/codegen-resources/service-2.json‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,22 @@
434434
],
435435
"documentation":"<p>Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.</p>"
436436
},
437+
"DescribeCAEnrollmentPolicy":{
438+
"name":"DescribeCAEnrollmentPolicy",
439+
"http":{
440+
"method":"POST",
441+
"requestUri":"/"
442+
},
443+
"input":{"shape":"DescribeCAEnrollmentPolicyRequest"},
444+
"output":{"shape":"DescribeCAEnrollmentPolicyResult"},
445+
"errors":[
446+
{"shape":"DirectoryDoesNotExistException"},
447+
{"shape":"UnsupportedOperationException"},
448+
{"shape":"ClientException"},
449+
{"shape":"ServiceException"}
450+
],
451+
"documentation":"<p>Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority. </p>"
452+
},
437453
"DescribeCertificate":{
438454
"name":"DescribeCertificate",
439455
"http":{
@@ -700,6 +716,26 @@
700716
],
701717
"documentation":"<p> Describes the updates of a directory for a particular update type. </p>"
702718
},
719+
"DisableCAEnrollmentPolicy":{
720+
"name":"DisableCAEnrollmentPolicy",
721+
"http":{
722+
"method":"POST",
723+
"requestUri":"/"
724+
},
725+
"input":{"shape":"DisableCAEnrollmentPolicyRequest"},
726+
"output":{"shape":"DisableCAEnrollmentPolicyResult"},
727+
"errors":[
728+
{"shape":"DirectoryDoesNotExistException"},
729+
{"shape":"DirectoryUnavailableException"},
730+
{"shape":"InvalidParameterException"},
731+
{"shape":"DisableAlreadyInProgressException"},
732+
{"shape":"EntityDoesNotExistException"},
733+
{"shape":"AccessDeniedException"},
734+
{"shape":"ClientException"},
735+
{"shape":"ServiceException"}
736+
],
737+
"documentation":"<p>Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.</p> <important> <p>Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.</p> </important>"
738+
},
703739
"DisableClientAuthentication":{
704740
"name":"DisableClientAuthentication",
705741
"http":{
@@ -788,6 +824,27 @@
788824
],
789825
"documentation":"<p>Disables single-sign on for a directory.</p>"
790826
},
827+
"EnableCAEnrollmentPolicy":{
828+
"name":"EnableCAEnrollmentPolicy",
829+
"http":{
830+
"method":"POST",
831+
"requestUri":"/"
832+
},
833+
"input":{"shape":"EnableCAEnrollmentPolicyRequest"},
834+
"output":{"shape":"EnableCAEnrollmentPolicyResult"},
835+
"errors":[
836+
{"shape":"DirectoryDoesNotExistException"},
837+
{"shape":"DirectoryUnavailableException"},
838+
{"shape":"InvalidParameterException"},
839+
{"shape":"EntityAlreadyExistsException"},
840+
{"shape":"EntityDoesNotExistException"},
841+
{"shape":"EnableAlreadyInProgressException"},
842+
{"shape":"ClientException"},
843+
{"shape":"ServiceException"},
844+
{"shape":"AccessDeniedException"}
845+
],
846+
"documentation":"<p>Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.</p> <note> <p>Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.</p> </note>"
847+
},
791848
"EnableClientAuthentication":{
792849
"name":"EnableClientAuthentication",
793850
"http":{
@@ -1762,6 +1819,18 @@
17621819
"type":"list",
17631820
"member":{"shape":"AvailabilityZone"}
17641821
},
1822+
"CaEnrollmentPolicyStatus":{
1823+
"type":"string",
1824+
"enum":[
1825+
"InProgress",
1826+
"Success",
1827+
"Failed",
1828+
"Disabling",
1829+
"Disabled",
1830+
"Impaired"
1831+
]
1832+
},
1833+
"CaEnrollmentPolicyStatusReason":{"type":"string"},
17651834
"CancelSchemaExtensionRequest":{
17661835
"type":"structure",
17671836
"required":[
@@ -2636,6 +2705,43 @@
26362705
}
26372706
}
26382707
},
2708+
"DescribeCAEnrollmentPolicyRequest":{
2709+
"type":"structure",
2710+
"required":["DirectoryId"],
2711+
"members":{
2712+
"DirectoryId":{
2713+
"shape":"DirectoryId",
2714+
"documentation":"<p>The identifier of the directory for which to retrieve the CA enrollment policy information.</p>"
2715+
}
2716+
},
2717+
"documentation":"<p>Contains the inputs for the <a>DescribeCAEnrollmentPolicy</a> operation.</p>"
2718+
},
2719+
"DescribeCAEnrollmentPolicyResult":{
2720+
"type":"structure",
2721+
"members":{
2722+
"DirectoryId":{
2723+
"shape":"DirectoryId",
2724+
"documentation":"<p>The identifier of the directory associated with this CA enrollment policy.</p>"
2725+
},
2726+
"PcaConnectorArn":{
2727+
"shape":"PcaConnectorArn",
2728+
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector that is configured for automatic certificate enrollment in this directory.</p>"
2729+
},
2730+
"CaEnrollmentPolicyStatus":{
2731+
"shape":"CaEnrollmentPolicyStatus",
2732+
"documentation":"<p>The current status of the CA enrollment policy. This indicates if automatic certificate enrollment is currently active, inactive, or in a transitional state.</p> <p>Valid values:</p> <ul> <li> <p> <code>IN_PROGRESS</code> - The policy is being activated T</p> </li> <li> <p> <code>SUCCESS</code> - The policy is active and automatic certificate enrollment is operational</p> </li> <li> <p> <code>FAILED</code> - The policy activation or deactivation failed</p> </li> <li> <p> <code>DISABLING</code> - The policy is being deactivated</p> </li> <li> <p> <code>DISABLED</code> - The policy is inactive and automatic certificate enrollment is not available</p> </li> <li> <p> <code>IMPAIRED</code> - Network connectivity is impaired.</p> </li> </ul>"
2733+
},
2734+
"LastUpdatedDateTime":{
2735+
"shape":"LastUpdatedDateTime",
2736+
"documentation":"<p>The date and time when the CA enrollment policy was last modified or updated.</p>"
2737+
},
2738+
"CaEnrollmentPolicyStatusReason":{
2739+
"shape":"CaEnrollmentPolicyStatusReason",
2740+
"documentation":"<p>Additional information explaining the current status of the CA enrollment policy, particularly useful when the policy is in an error or transitional state.</p>"
2741+
}
2742+
},
2743+
"documentation":"<p>Contains the results of the <a>DescribeCAEnrollmentPolicy</a> operation.</p>"
2744+
},
26392745
"DescribeCertificateRequest":{
26402746
"type":"structure",
26412747
"required":[
@@ -3531,6 +3637,31 @@
35313637
},
35323638
"documentation":"<p>Contains information about the directory.</p>"
35333639
},
3640+
"DisableAlreadyInProgressException":{
3641+
"type":"structure",
3642+
"members":{
3643+
"Message":{"shape":"ExceptionMessage"},
3644+
"RequestId":{"shape":"RequestId"}
3645+
},
3646+
"documentation":"<p>A disable operation for CA enrollment policy is already in progress for this directory.</p>",
3647+
"exception":true
3648+
},
3649+
"DisableCAEnrollmentPolicyRequest":{
3650+
"type":"structure",
3651+
"required":["DirectoryId"],
3652+
"members":{
3653+
"DirectoryId":{
3654+
"shape":"DirectoryId",
3655+
"documentation":"<p>The identifier of the directory for which to disable the CA enrollment policy.</p>"
3656+
}
3657+
},
3658+
"documentation":"<p>Contains the inputs for the <a>DisableCAEnrollmentPolicy</a> operation.</p>"
3659+
},
3660+
"DisableCAEnrollmentPolicyResult":{
3661+
"type":"structure",
3662+
"members":{},
3663+
"documentation":"<p>Contains the results of the <a>DisableCAEnrollmentPolicy</a> operation.</p>"
3664+
},
35343665
"DisableClientAuthenticationRequest":{
35353666
"type":"structure",
35363667
"required":[
@@ -3712,6 +3843,38 @@
37123843
"type":"list",
37133844
"member":{"shape":"DomainController"}
37143845
},
3846+
"EnableAlreadyInProgressException":{
3847+
"type":"structure",
3848+
"members":{
3849+
"Message":{"shape":"ExceptionMessage"},
3850+
"RequestId":{"shape":"RequestId"}
3851+
},
3852+
"documentation":"<p>An enable operation for CA enrollment policy is already in progress for this directory.</p>",
3853+
"exception":true
3854+
},
3855+
"EnableCAEnrollmentPolicyRequest":{
3856+
"type":"structure",
3857+
"required":[
3858+
"DirectoryId",
3859+
"PcaConnectorArn"
3860+
],
3861+
"members":{
3862+
"DirectoryId":{
3863+
"shape":"DirectoryId",
3864+
"documentation":"<p>The identifier of the directory for which to enable the CA enrollment policy.</p>"
3865+
},
3866+
"PcaConnectorArn":{
3867+
"shape":"PcaConnectorArn",
3868+
"documentation":"<p>The Amazon Resource Name (ARN) of the Private Certificate Authority (PCA) connector to use for automatic certificate enrollment. This connector must be properly configured and accessible from the directory.</p> <p>The ARN format is: <code>arn:aws:pca-connector-ad:<i>region</i>:<i>account-id</i>:connector/<i>connector-id</i> </code> </p>"
3869+
}
3870+
},
3871+
"documentation":"<p>Contains the inputs for the <a>EnableCAEnrollmentPolicy</a> operation.</p>"
3872+
},
3873+
"EnableCAEnrollmentPolicyResult":{
3874+
"type":"structure",
3875+
"members":{},
3876+
"documentation":"<p>Contains the results of the <a>EnableCAEnrollmentPolicy</a> operation.</p>"
3877+
},
37153878
"EnableClientAuthenticationRequest":{
37163879
"type":"structure",
37173880
"required":[
@@ -4540,6 +4703,10 @@
45404703
"pattern":"(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*",
45414704
"sensitive":true
45424705
},
4706+
"PcaConnectorArn":{
4707+
"type":"string",
4708+
"pattern":"^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
4709+
},
45434710
"PortNumber":{
45444711
"type":"integer",
45454712
"max":65535,

0 commit comments

Comments
 (0)