Struct aws_sdk_kms::client::fluent_builders::GetKeyPolicy
source · pub struct GetKeyPolicy { /* private fields */ }
Expand description
Fluent builder constructing a request to GetKeyPolicy
.
Gets a key policy attached to the specified KMS key.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:GetKeyPolicy (key policy)
Related operations: PutKeyPolicy
Implementations§
source§impl GetKeyPolicy
impl GetKeyPolicy
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<GetKeyPolicy, AwsResponseRetryClassifier>, SdkError<GetKeyPolicyError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<GetKeyPolicy, AwsResponseRetryClassifier>, SdkError<GetKeyPolicyError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<GetKeyPolicyOutput, SdkError<GetKeyPolicyError>>
pub async fn send(
self
) -> Result<GetKeyPolicyOutput, SdkError<GetKeyPolicyError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
Gets the key policy for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
Gets the key policy for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
sourcepub fn policy_name(self, input: impl Into<String>) -> Self
pub fn policy_name(self, input: impl Into<String>) -> Self
Specifies the name of the key policy. The only valid name is default
. To get the names of key policies, use ListKeyPolicies
.
sourcepub fn set_policy_name(self, input: Option<String>) -> Self
pub fn set_policy_name(self, input: Option<String>) -> Self
Specifies the name of the key policy. The only valid name is default
. To get the names of key policies, use ListKeyPolicies
.
Trait Implementations§
source§impl Clone for GetKeyPolicy
impl Clone for GetKeyPolicy
source§fn clone(&self) -> GetKeyPolicy
fn clone(&self) -> GetKeyPolicy
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more