aws_sdk_ram/client/
get_resource_share_associations.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetResourceShareAssociations`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`association_type(ResourceShareAssociationType)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::association_type) / [`set_association_type(Option<ResourceShareAssociationType>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_association_type):<br>required: **true**<br><p>Specifies whether you want to retrieve the associations that involve a specified resource or principal.</p> <ul>  <li>   <p><code>PRINCIPAL</code> – list the principals whose associations you want to see.</p></li>  <li>   <p><code>RESOURCE</code> – list the resources whose associations you want to see.</p></li> </ul><br>
    ///   - [`resource_share_arns(impl Into<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::resource_share_arns) / [`set_resource_share_arns(Option<Vec::<String>>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_resource_share_arns):<br>required: **false**<br><p>Specifies a list of <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of the resource share whose associations you want to retrieve.</p><br>
    ///   - [`resource_arn(impl Into<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_resource_arn):<br>required: **false**<br><p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of a resource whose resource shares you want to retrieve.</p> <p>You cannot specify this parameter if the association type is <code>PRINCIPAL</code>.</p><br>
    ///   - [`principal(impl Into<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::principal) / [`set_principal(Option<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_principal):<br>required: **false**<br><p>Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an individual IAM role or user.</p> <p>You cannot specify this parameter if the association type is <code>RESOURCE</code>.</p><br>
    ///   - [`association_status(ResourceShareAssociationStatus)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::association_status) / [`set_association_status(Option<ResourceShareAssociationStatus>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_association_status):<br>required: **false**<br><p>Specifies that you want to retrieve only associations that have this status.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_next_token):<br>required: **false**<br><p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::set_max_results):<br>required: **false**<br><p>Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p><br>
    /// - On success, responds with [`GetResourceShareAssociationsOutput`](crate::operation::get_resource_share_associations::GetResourceShareAssociationsOutput) with field(s):
    ///   - [`resource_share_associations(Option<Vec::<ResourceShareAssociation>>)`](crate::operation::get_resource_share_associations::GetResourceShareAssociationsOutput::resource_share_associations): <p>An array of objects that contain the details about the associations.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::get_resource_share_associations::GetResourceShareAssociationsOutput::next_token): <p>If present, this value indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. This indicates that this is the last page of results.</p>
    /// - On failure, responds with [`SdkError<GetResourceShareAssociationsError>`](crate::operation::get_resource_share_associations::GetResourceShareAssociationsError)
    pub fn get_resource_share_associations(
        &self,
    ) -> crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder {
        crate::operation::get_resource_share_associations::builders::GetResourceShareAssociationsFluentBuilder::new(self.handle.clone())
    }
}