B2BI / Client / update_profile

update_profile#

B2BI.Client.update_profile(**kwargs)#

Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

See also: AWS API Documentation

Request Syntax

response = client.update_profile(
    profileId='string',
    name='string',
    email='string',
    phone='string',
    businessName='string'
)
Parameters:

  • profileId (string) –

    [REQUIRED]

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

  • name (string) – The name of the profile, used to identify it.

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

  • phone (string) – Specifies the phone number associated with the profile.

  • businessName (string) – Specifies the name for the business associated with this profile.

Return type:

dict

Returns:

Response Syntax

{
    'profileId': 'string',
    'profileArn': 'string',
    'name': 'string',
    'email': 'string',
    'phone': 'string',
    'businessName': 'string',
    'logging': 'ENABLED'|'DISABLED',
    'logGroupName': 'string',
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': 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.

    • email (string) –

      Returns the email address associated with this customer profile.

    • phone (string) –

      Returns the phone number associated with the profile.

    • businessName (string) –

      Returns the name for the business associated with this profile.

    • logging (string) –

      Specifies whether or not logging is enabled for this profile.

    • logGroupName (string) –

      Returns the name of the logging group.

    • createdAt (datetime) –

      Returns a timestamp for creation date and time of the profile.

    • modifiedAt (datetime) –

      Returns a timestamp for last time the profile was modified.

Exceptions

  • B2BI.Client.exceptions.ConflictException

  • B2BI.Client.exceptions.AccessDeniedException

  • B2BI.Client.exceptions.ValidationException

  • B2BI.Client.exceptions.ThrottlingException

  • B2BI.Client.exceptions.ResourceNotFoundException

  • B2BI.Client.exceptions.ServiceQuotaExceededException

  • B2BI.Client.exceptions.InternalServerException