B2BI / Client / get_profile

get_profile#

B2BI.Client.get_profile(**kwargs)#

Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.

Request Syntax

response = client.get_profile(
    profileId='string'
)

Parameters:

profileId (string) –

[REQUIRED]

Specifies the unique, system-generated identifier for the 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 a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
- name (string) –
  
  Returns the name of the profile, used to identify it.
- 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) –
  
  Returns 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 transformer.
- modifiedAt (datetime) –
  
  Returns a timestamp for last time the profile was modified.

Exceptions

B2BI.Client.exceptions.AccessDeniedException
B2BI.Client.exceptions.ValidationException
B2BI.Client.exceptions.ThrottlingException
B2BI.Client.exceptions.ResourceNotFoundException
B2BI.Client.exceptions.InternalServerException