[ aws . customer-profiles ]

list-profile-objects

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-profile-objects
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
--object-type-name <value>
--profile-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

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)

The pagination token from the previous call to ListProfileObjects.