IAMRolesAnywhere / Paginator / ListProfiles

ListProfiles#

class IAMRolesAnywhere.Paginator.ListProfiles#
paginator = client.get_paginator('list_profiles')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from IAMRolesAnywhere.Client.list_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    pageSize=123,
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • pageSize (integer) – The number of resources in the paginated list.

  • 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.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'profiles': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'durationSeconds': 123,
            'enabled': True|False,
            'managedPolicyArns': [
                'string',
            ],
            'name': 'string',
            'profileArn': 'string',
            'profileId': 'string',
            'requireInstanceProperties': True|False,
            'roleArns': [
                'string',
            ],
            'sessionPolicy': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • profiles (list) –

      A list of profiles.

      • (dict) –

        The state of the profile after a read or write operation.

        • createdAt (datetime) –

          The ISO-8601 timestamp when the profile was created.

        • createdBy (string) –

          The Amazon Web Services account that created the profile.

        • durationSeconds (integer) –

          Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details.

        • enabled (boolean) –

          Indicates whether the profile is enabled.

        • managedPolicyArns (list) –

          A list of managed policy ARNs that apply to the vended session credentials.

          • (string) –

        • name (string) –

          The name of the profile.

        • profileArn (string) –

          The ARN of the profile.

        • profileId (string) –

          The unique identifier of the profile.

        • requireInstanceProperties (boolean) –

          Specifies whether instance properties are required in temporary credential requests with this profile.

        • roleArns (list) –

          A list of IAM roles that this profile can assume in a temporary credential request.

          • (string) –

        • sessionPolicy (string) –

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt (datetime) –

          The ISO-8601 timestamp when the profile was last updated.

    • NextToken (string) –

      A token to resume pagination.