EFS / Client / describe_account_preferences

describe_account_preferences#

EFS.Client.describe_account_preferences(**kwargs)#

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. For more information, see Managing Amazon EFS resource IDs.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_preferences(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – (Optional) You can use NextToken in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.

  • MaxResults (integer) – (Optional) When retrieving account preferences, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceIdPreference': {
        'ResourceIdType': 'LONG_ID'|'SHORT_ID',
        'Resources': [
            'FILE_SYSTEM'|'MOUNT_TARGET',
        ]
    },
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ResourceIdPreference (dict) –

      Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

      • ResourceIdType (string) –

        Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters).

      • Resources (list) –

        Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET.

        • (string) – An EFS resource, for example a file system or a mount target.

    • NextToken (string) –

      Present if there are more records than returned in the response. You can use the NextToken in the subsequent request to fetch the additional descriptions.

Exceptions

  • EFS.Client.exceptions.InternalServerError