RAM / Paginator / GetResourceShares

GetResourceShares#

class RAM.Paginator.GetResourceShares#

paginator = client.get_paginator('get_resource_shares')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from RAM.Client.get_resource_shares().

Request Syntax

response_iterator = paginator.paginate(
    resourceShareArns=[
        'string',
    ],
    resourceShareStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    name='string',
    tagFilters=[
        {
            'tagKey': 'string',
            'tagValues': [
                'string',
            ]
        },
    ],
    permissionArn='string',
    permissionVersion=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

resourceShareArns (list) –
Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
- (string) –
resourceShareStatus (string) – Specifies that you want to retrieve details of only those resource shares that have this status.
resourceOwner (string) –
[REQUIRED]

Specifies that you want to retrieve details of only those resource shares that match the following:
- SELF – resource shares that your account shares with other accounts
- OTHER-ACCOUNTS – resource shares that other accounts share with your account
name (string) – Specifies the name of an individual resource share that you want to retrieve details about.
tagFilters (list) –
Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
- (dict) –
  
  A tag key and optional list of possible values that you can use to filter results for tagged resources.
  - tagKey (string) –
    
    The tag key. This must have a valid string value and can’t be empty.
  - tagValues (list) –
    
    A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.
    - (string) –
permissionArn (string) – Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).
permissionVersion (integer) – Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'resourceShares': [
        {
            'resourceShareArn': 'string',
            'name': 'string',
            'owningAccountId': 'string',
            'allowExternalPrincipals': True|False,
            'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
            'statusMessage': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- resourceShares (list) –
  
  An array of objects that contain the information about the resource shares.
  - (dict) –
    
    Describes a resource share in RAM.
    - resourceShareArn (string) –
      
      The Amazon Resource Name (ARN) of the resource share
    - name (string) –
      
      The name of the resource share.
    - owningAccountId (string) –
      
      The ID of the Amazon Web Services account that owns the resource share.
    - allowExternalPrincipals (boolean) –
      
      Indicates whether principals outside your organization in Organizations can be associated with a resource share.
      - True – the resource share can be shared with any Amazon Web Services account.
      - False – the resource share can be shared with only accounts in the same organization as the account that owns the resource share.
    - status (string) –
      
      The current status of the resource share.
    - statusMessage (string) –
      
      A message about the status of the resource share.
    - tags (list) –
      
      The tag key and value pairs attached to the resource share.
      - (dict) –
        
        A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.
        
        For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
        
        key (string) –
        
        The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.
        
        value (string) –
        
        The string value attached to the tag. The value can be an empty string. Key values are case sensitive.
    - creationTime (datetime) –
      
      The date and time when the resource share was created.
    - lastUpdatedTime (datetime) –
      
      The date and time when the resource share was last updated.
    - featureSet (string) –
      
      Indicates what features are available for this resource share. This parameter can have one of the following values:
      - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
      - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer’s behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can’t modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
      - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
- NextToken (string) –
  
  A token to resume pagination.