CloudWatchOmni / Client / create_access_profile

create_access_profile¶

CloudWatchOmni.Client.create_access_profile(**kwargs)¶

Creates an access profile in a space.

Use GetAccessProfile and ListAccessProfiles to retrieve profiles, and UpdateAccessProfile to modify one.

Request Syntax

response = client.create_access_profile(
    spaceId='string',
    name='string',
    description='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the space to create the profile in.
name (string) –
[REQUIRED]

A name that identifies the access profile.
description (string) – An optional description of the access profile.
tags (dict) –
The tags to associate with the access profile.
- (string) –
  
  Tag key. Must be non-empty; AWS-standard maximum length. Constraining the key (rather than a bare String) rejects empty-key payloads at the edge with a 400 ValidationException instead of faulting downstream as a 500.
  - (string) –
    
    Tag value. AWS-standard maximum length; may be empty.
clientToken (string) –
Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'accessProfile': {
        'profileId': 'string',
        'spaceId': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'assumeStatus': 'ALLOWED'|'DENIED',
        'profileType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED'
    }
}

Response Structure

(dict) –
- accessProfile (dict) –
  
  The access profile.
  - profileId (string) –
    
    The unique ID of the access profile.
  - spaceId (string) –
    
    The ID of the space the profile belongs to.
  - arn (string) –
    
    The ARN of this access profile.
  - name (string) –
    
    A name that identifies the access profile.
  - description (string) –
    
    An optional description of the access profile.
  - createdAt (datetime) –
    
    The timestamp when the access profile was created.
  - updatedAt (datetime) –
    
    The timestamp when the access profile was last updated.
  - assumeStatus (string) –
    
    The calling principal’s authorization to assume this access profile.
  - profileType (string) –
    
    Who manages the access profile.

Exceptions

CloudWatchOmni.Client.exceptions.ThrottlingException
CloudWatchOmni.Client.exceptions.ValidationException
CloudWatchOmni.Client.exceptions.ResourceNotFoundException
CloudWatchOmni.Client.exceptions.AccessDeniedException
CloudWatchOmni.Client.exceptions.InternalServerException
CloudWatchOmni.Client.exceptions.ConflictException
CloudWatchOmni.Client.exceptions.ServiceQuotaExceededException