Struct aws_sdk_ram::operation::list_principals::ListPrincipalsInput

#[non_exhaustive]
pub struct ListPrincipalsInput {
    pub resource_owner: Option<ResourceOwner>,
    pub resource_arn: Option<String>,
    pub principals: Option<Vec<String>>,
    pub resource_type: Option<String>,
    pub resource_share_arns: Option<Vec<String>>,
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

resource_owner: Option<ResourceOwner>

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

resource_arn: Option<String>

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

principals: Option<Vec<String>>

Specifies that you want to list information for only the listed principals.

You can include the following values:

• An Amazon Web Services account ID, for example: 123456789012

• An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

• An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

• An ARN of an IAM role, for example: iam::123456789012:role/rolename

• An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

resource_type: Option<String>

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

resource_share_arns: Option<Vec<String>>

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

next_token: Option<String>

Specifies that you want to receive the next page of results. Valid only if you received a NextToken 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 NextToken response to request the next page of results.

max_results: Option<i32>

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 NextToken response element is returned with a value (not null). Include the specified value as the NextToken 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 NextToken after every operation to ensure that you receive all of the results.

Implementations

impl ListPrincipalsInput

pub fn resource_owner(&self) -> Option<&ResourceOwner>

Specifies that you want to list information for only resource shares that match the following:

• SELF – principals that your account is sharing resources with

• OTHER-ACCOUNTS – principals that are sharing resources with your account

pub fn resource_arn(&self) -> Option<&str>

Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).

pub fn principals(&self) -> &[String]

Specifies that you want to list information for only the listed principals.

You can include the following values:

• An Amazon Web Services account ID, for example: 123456789012

• An Amazon Resource Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid

• An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123

• An ARN of an IAM role, for example: iam::123456789012:role/rolename

• An ARN of an IAM user, for example: iam::123456789012user/username

Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .principals.is_none().

pub fn resource_type(&self) -> Option<&str>

Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.

For a list of valid values, query the ListResourceTypes operation.

pub fn resource_share_arns(&self) -> &[String]

Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .resource_share_arns.is_none().

pub fn next_token(&self) -> Option<&str>

Specifies that you want to receive the next page of results. Valid only if you received a NextToken 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 NextToken response to request the next page of results.

pub fn max_results(&self) -> Option<i32>

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 NextToken response element is returned with a value (not null). Include the specified value as the NextToken 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 NextToken after every operation to ensure that you receive all of the results.

impl ListPrincipalsInput

pub fn builder() -> ListPrincipalsInputBuilder

Creates a new builder-style object to manufacture ListPrincipalsInput.

Trait Implementations

impl Clone for ListPrincipalsInput

fn clone(&self) -> ListPrincipalsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListPrincipalsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ListPrincipalsInput

fn eq(&self, other: &ListPrincipalsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListPrincipalsInput