B2BI / Client / create_profile

create_profile#

B2BI.Client.create_profile(**kwargs)#

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

See also: AWS API Documentation

Request Syntax

response = client.create_profile(
    name='string',
    email='string',
    phone='string',
    businessName='string',
    logging='ENABLED'|'DISABLED',
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • name (string) –

    [REQUIRED]

    Specifies the name of the profile.

  • email (string) – Specifies the email address associated with this customer profile.

  • phone (string) –

    [REQUIRED]

    Specifies the phone number associated with the profile.

  • businessName (string) –

    [REQUIRED]

    Specifies the name for the business associated with this profile.

  • logging (string) –

    [REQUIRED]

    Specifies whether or not logging is enabled for this profile.

  • clientToken (string) –

    Reserved for future use.

    This field is autopopulated if not provided.

  • tags (list) –

    Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

    • (dict) –

      Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

      • Key (string) – [REQUIRED]

        Specifies the name assigned to the tag that you create.

      • Value (string) – [REQUIRED]

        Contains one or more values that you assigned to the key name that you create.

Return type:

dict

Returns:

Response Syntax

{
    'profileId': 'string',
    'profileArn': 'string',
    'name': 'string',
    'businessName': 'string',
    'phone': 'string',
    'email': 'string',
    'logging': 'ENABLED'|'DISABLED',
    'logGroupName': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • profileId (string) –

      Returns the unique, system-generated identifier for the profile.

    • profileArn (string) –

      Returns an Amazon Resource Name (ARN) for the profile.

    • name (string) –

      Returns the name of the profile, used to identify it.

    • businessName (string) –

      Returns the name for the business associated with this profile.

    • phone (string) –

      Returns the phone number associated with the profile.

    • email (string) –

      Returns the email address associated with this customer profile.

    • logging (string) –

      Returns whether or not logging is turned on for this profile.

    • logGroupName (string) –

      Returns the name of the logging group.

    • createdAt (datetime) –

      Returns a timestamp representing the time the profile was created.

Exceptions