Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListProfiles

Lists the profiles associated with your AWS account for your current or specified region. A profile is the mechanism used to create the concept of a private network.

Request Syntax


{
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

Specifies the maximum number of profiles to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax


{
   "nextToken": "string",
   "profiles": [ 
      { 
         "businessName": "string",
         "createdAt": "string",
         "logging": "string",
         "logGroupName": "string",
         "modifiedAt": "string",
         "name": "string",
         "profileId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

profiles

Returns an array of ProfileSummary objects.

Type: Array of ProfileSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

The following example lists the profiles for your account and in your region. Note that in this example, there is only one profile listed: however, this call would return up to 5 profiles.

Sample Request


{
    "maxResults": 5,
    "nextToken": "foo"
}

Sample Response


{
    "nextToken": "foo",
    "profiles": [
        {
            "businessName": "John's Trucking",
            "createdAt": "2023-11-01T21:51:05.504Z",
            "logging": "ENABLED",
            "logGroupName": "b2bi/p-ABCDE111122223333-Logs",
            "name": "Shipping Profile",
            "profileId": "p-ABCDE111122223333"
        }
    ]
}