Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . customer-profiles ]

list-profile-objects¶

Description¶

Returns a list of objects associated with a profile of a given ProfileObjectType.

Synopsis¶

  list-profile-objects
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
--object-type-name <value>
--profile-id <value>
[--object-filter <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--next-token (string)

The pagination token from the previous call to ListProfileObjects.

--max-results (integer)

The maximum number of objects returned per page.

--domain-name (string)

The unique name of the domain.

--object-type-name (string)

The name of the profile object type.

--profile-id (string)

The unique identifier of a customer profile.

--object-filter (structure)

Applies a filter to the response to include profile objects with the specified index values.

KeyName -> (string)

A searchable identifier of a profile object. The predefined keys you can use to search for _asset include: _assetId , _assetName , and _serialNumber . The predefined keys you can use to search for _case include: _caseId . The predefined keys you can use to search for _order include: _orderId .

Values -> (list)

A list of key values.

(string)

Shorthand Syntax:

KeyName=string,Values=string,string

JSON Syntax:

{
  "KeyName": "string",
  "Values": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

Items -> (list)

The list of ListProfileObject instances.

(structure)

A ProfileObject in a list of ProfileObjects.

ObjectTypeName -> (string)

Specifies the kind of object being added to a profile, such as "Salesforce-Account."

ProfileObjectUniqueKey -> (string)

The unique identifier of the ProfileObject generated by the service.

Object -> (string)

A JSON representation of a ProfileObject that belongs to a profile.

NextToken -> (string)