EndUserMessaging / Client / create_brand_profile_from_registration

create_brand_profile_from_registration

EndUserMessaging.Client.create_brand_profile_from_registration(**kwargs)

Creates a brand profile and populates its attributes from an existing registration. This operation runs asynchronously. Use the GetJob operation to track its progress.

See also: AWS API Documentation

Request Syntax

response = client.create_brand_profile_from_registration(
    registrationId='string',
    brandProfileName='string',
    smartMatch=True|False,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    clientToken='string'
)
Parameters:

  • registrationId (string) –

    [REQUIRED]

    The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.

  • brandProfileName (string) –

    [REQUIRED]

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

  • smartMatch (boolean) – Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

  • tags (list) –

    An array of key and value pair tags that are associated with the resource.

    • (dict) –

      Describes a tag as a key and value pair that you can associate with a resource.

      • key (string) – [REQUIRED]

        The key of the tag.

      • value (string) – [REQUIRED]

        The value of the tag.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'results': [
        {
            'jobId': 'string',
            'resourceIdentifier': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • results (list) –

      The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

      • (dict) –

        Pairs an asynchronous job with the resource identifier from your request that the job processes.

        • jobId (string) –

          The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

        • resourceIdentifier (string) –

          The identifier from your request that this job is processing.

Exceptions

  • EndUserMessaging.Client.exceptions.ValidationException

  • EndUserMessaging.Client.exceptions.ThrottlingException

  • EndUserMessaging.Client.exceptions.AccessDeniedException

  • EndUserMessaging.Client.exceptions.ResourceNotFoundException

  • EndUserMessaging.Client.exceptions.InternalServerException

  • EndUserMessaging.Client.exceptions.ConflictException

  • EndUserMessaging.Client.exceptions.ServiceQuotaExceededException