@aws-sdk/client-acm-pca 3.858.0 → 3.859.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -16
- package/dist-types/ACMPCA.d.ts +1 -16
- package/dist-types/ACMPCAClient.d.ts +1 -16
- package/dist-types/commands/CreateCertificateAuthorityAuditReportCommand.d.ts +3 -13
- package/dist-types/commands/CreateCertificateAuthorityCommand.d.ts +4 -27
- package/dist-types/commands/CreatePermissionCommand.d.ts +4 -33
- package/dist-types/commands/DeleteCertificateAuthorityCommand.d.ts +3 -24
- package/dist-types/commands/DeletePermissionCommand.d.ts +3 -33
- package/dist-types/commands/DeletePolicyCommand.d.ts +4 -42
- package/dist-types/commands/DescribeCertificateAuthorityAuditReportCommand.d.ts +3 -8
- package/dist-types/commands/DescribeCertificateAuthorityCommand.d.ts +3 -45
- package/dist-types/commands/GetCertificateAuthorityCertificateCommand.d.ts +3 -8
- package/dist-types/commands/GetCertificateAuthorityCsrCommand.d.ts +3 -9
- package/dist-types/commands/GetCertificateCommand.d.ts +3 -12
- package/dist-types/commands/GetPolicyCommand.d.ts +3 -35
- package/dist-types/commands/ImportCertificateAuthorityCertificateCommand.d.ts +4 -132
- package/dist-types/commands/IssueCertificateCommand.d.ts +4 -14
- package/dist-types/commands/ListCertificateAuthoritiesCommand.d.ts +1 -2
- package/dist-types/commands/ListPermissionsCommand.d.ts +4 -34
- package/dist-types/commands/ListTagsCommand.d.ts +3 -8
- package/dist-types/commands/PutPolicyCommand.d.ts +5 -41
- package/dist-types/commands/RestoreCertificateAuthorityCommand.d.ts +3 -15
- package/dist-types/commands/RevokeCertificateCommand.d.ts +4 -26
- package/dist-types/commands/TagCertificateAuthorityCommand.d.ts +5 -23
- package/dist-types/commands/UntagCertificateAuthorityCommand.d.ts +4 -11
- package/dist-types/commands/UpdateCertificateAuthorityCommand.d.ts +4 -17
- package/dist-types/index.d.ts +1 -16
- package/dist-types/models/models_0.d.ts +151 -848
- package/package.json +2 -2
|
@@ -27,21 +27,7 @@ declare const TagCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Adds one or more tags to your private CA. Tags are labels that you can use to identify
|
|
31
|
-
* and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You
|
|
32
|
-
* specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag
|
|
33
|
-
* by using a key-value pair. You can apply a tag to just one private CA if you want to
|
|
34
|
-
* identify a specific characteristic of that CA, or you can apply the same tag to multiple
|
|
35
|
-
* private CAs if you want to filter for a common relationship among those CAs. To remove
|
|
36
|
-
* one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
|
|
37
|
-
* associated with your CA. </p>
|
|
38
|
-
* <note>
|
|
39
|
-
* <p>To attach tags to a private CA during the creation procedure, a CA administrator
|
|
40
|
-
* must first associate an inline IAM policy with the
|
|
41
|
-
* <code>CreateCertificateAuthority</code> action and explicitly allow tagging. For
|
|
42
|
-
* more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching tags to a CA
|
|
43
|
-
* at the time of creation</a>.</p>
|
|
44
|
-
* </note>
|
|
30
|
+
* <p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html">UntagCertificateAuthority</a> action. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are associated with your CA. </p> <note> <p>To attach tags to a private CA during the creation procedure, a CA administrator must first associate an inline IAM policy with the <code>CreateCertificateAuthority</code> action and explicitly allow tagging. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/auth-InlinePolicies.html#policy-tag-ca">Attaching tags to a CA at the time of creation</a>.</p> </note>
|
|
45
31
|
* @example
|
|
46
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
47
33
|
* ```javascript
|
|
@@ -70,23 +56,19 @@ declare const TagCertificateAuthorityCommand_base: {
|
|
|
70
56
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
71
57
|
*
|
|
72
58
|
* @throws {@link InvalidArnException} (client fault)
|
|
73
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
74
|
-
* resource.</p>
|
|
59
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
75
60
|
*
|
|
76
61
|
* @throws {@link InvalidStateException} (client fault)
|
|
77
62
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
78
63
|
*
|
|
79
64
|
* @throws {@link InvalidTagException} (client fault)
|
|
80
|
-
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the
|
|
81
|
-
* message field.</p>
|
|
65
|
+
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>
|
|
82
66
|
*
|
|
83
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
85
|
-
* cannot be found.</p>
|
|
68
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
86
69
|
*
|
|
87
70
|
* @throws {@link TooManyTagsException} (client fault)
|
|
88
|
-
* <p>You can associate up to 50 tags with a private CA. Exception information is contained
|
|
89
|
-
* in the exception message field.</p>
|
|
71
|
+
* <p>You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.</p>
|
|
90
72
|
*
|
|
91
73
|
* @throws {@link ACMPCAServiceException}
|
|
92
74
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,11 +27,7 @@ declare const UntagCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If
|
|
31
|
-
* you do not specify the value portion of the tag when calling this action, the tag will
|
|
32
|
-
* be removed regardless of value. If you specify a value, the tag is removed only if it is
|
|
33
|
-
* associated with the specified value. To add tags to a private CA, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are
|
|
34
|
-
* associated with your CA. </p>
|
|
30
|
+
* <p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html">TagCertificateAuthority</a>. Call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_ListTags.html">ListTags</a> action to see what tags are associated with your CA. </p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -60,19 +56,16 @@ declare const UntagCertificateAuthorityCommand_base: {
|
|
|
60
56
|
* @see {@link ACMPCAClientResolvedConfig | config} for ACMPCAClient's `config` shape.
|
|
61
57
|
*
|
|
62
58
|
* @throws {@link InvalidArnException} (client fault)
|
|
63
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
64
|
-
* resource.</p>
|
|
59
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
65
60
|
*
|
|
66
61
|
* @throws {@link InvalidStateException} (client fault)
|
|
67
62
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
68
63
|
*
|
|
69
64
|
* @throws {@link InvalidTagException} (client fault)
|
|
70
|
-
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the
|
|
71
|
-
* message field.</p>
|
|
65
|
+
* <p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>
|
|
72
66
|
*
|
|
73
67
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
75
|
-
* cannot be found.</p>
|
|
68
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
76
69
|
*
|
|
77
70
|
* @throws {@link ACMPCAServiceException}
|
|
78
71
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
|
@@ -27,17 +27,7 @@ declare const UpdateCertificateAuthorityCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the status or configuration of a private certificate authority (CA). Your
|
|
31
|
-
* private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you
|
|
32
|
-
* can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or
|
|
33
|
-
* make a CA that is in the <code>DISABLED</code> state active again.</p>
|
|
34
|
-
* <note>
|
|
35
|
-
* <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to
|
|
36
|
-
* the S3 bucket that you specify. If the IAM principal making the call
|
|
37
|
-
* does not have permission to write to the bucket, then an exception is
|
|
38
|
-
* thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access
|
|
39
|
-
* policies for CRLs in Amazon S3</a>.</p>
|
|
40
|
-
* </note>
|
|
30
|
+
* <p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or make a CA that is in the <code>DISABLED</code> state active again.</p> <note> <p>Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see <a href="https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#s3-policies">Access policies for CRLs in Amazon S3</a>.</p> </note>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -85,19 +75,16 @@ declare const UpdateCertificateAuthorityCommand_base: {
|
|
|
85
75
|
* <p>One or more of the specified arguments was not valid.</p>
|
|
86
76
|
*
|
|
87
77
|
* @throws {@link InvalidArnException} (client fault)
|
|
88
|
-
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing
|
|
89
|
-
* resource.</p>
|
|
78
|
+
* <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
|
|
90
79
|
*
|
|
91
80
|
* @throws {@link InvalidPolicyException} (client fault)
|
|
92
|
-
* <p>The resource policy is invalid or is missing a required statement. For general
|
|
93
|
-
* information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
|
|
81
|
+
* <p>The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json">Overview of JSON Policies</a>.</p>
|
|
94
82
|
*
|
|
95
83
|
* @throws {@link InvalidStateException} (client fault)
|
|
96
84
|
* <p>The state of the private CA does not allow this action to occur.</p>
|
|
97
85
|
*
|
|
98
86
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
99
|
-
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy
|
|
100
|
-
* cannot be found.</p>
|
|
87
|
+
* <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
|
|
101
88
|
*
|
|
102
89
|
* @throws {@link ACMPCAServiceException}
|
|
103
90
|
* <p>Base exception class for all service exceptions from ACMPCA service.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,20 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions,
|
|
3
|
-
* syntax, and usage examples for each of the actions and data types involved in creating
|
|
4
|
-
* and managing a private certificate authority (CA) for your organization.</p>
|
|
5
|
-
* <p>The documentation for each action shows the API request parameters and the JSON
|
|
6
|
-
* response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is
|
|
7
|
-
* tailored to the programming language or platform that you prefer. For more information,
|
|
8
|
-
* see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
|
|
9
|
-
* <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the
|
|
10
|
-
* operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates
|
|
11
|
-
* depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid
|
|
12
|
-
* request because the request exceeds the operation's quota for the number of requests per
|
|
13
|
-
* second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request
|
|
14
|
-
* rate for APIs. </p>
|
|
15
|
-
* <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase,
|
|
16
|
-
* log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a>
|
|
17
|
-
* console.</p>
|
|
2
|
+
* <p>This is the <i>Amazon Web Services Private Certificate Authority API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.</p> <p>The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see <a href="https://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p> <p>Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/CommonErrors.html">ThrottlingException</a> error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs. </p> <p>To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the <a href="https://console.aws.amazon.com/servicequotas/">Service Quotas</a> console.</p>
|
|
18
3
|
*
|
|
19
4
|
* @packageDocumentation
|
|
20
5
|
*/
|