Mobile / Client / describe_project

describe_project#

Mobile.Client.describe_project(**kwargs)#

Gets details about a project in AWS Mobile Hub.

Request Syntax

response = client.describe_project(
    projectId='string',
    syncFromResources=True|False
)

Parameters:

projectId (string) –
[REQUIRED]

Unique project identifier.
syncFromResources (boolean) – If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.

Return type:

dict

Returns:

Response Syntax

{
    'details': {
        'name': 'string',
        'projectId': 'string',
        'region': 'string',
        'state': 'NORMAL'|'SYNCING'|'IMPORTING',
        'createdDate': datetime(2015, 1, 1),
        'lastUpdatedDate': datetime(2015, 1, 1),
        'consoleUrl': 'string',
        'resources': [
            {
                'type': 'string',
                'name': 'string',
                'arn': 'string',
                'feature': 'string',
                'attributes': {
                    'string': 'string'
                }
            },
        ]
    }
}

Response Structure

(dict) –

Result structure used for requests of project details.
- details (dict) –
  
  Detailed information about an AWS Mobile Hub project.
  - name (string) –
    
    Name of the project.
  - projectId (string) –
    
    Unique project identifier.
  - region (string) –
    
    Default region to use for AWS resource creation in the AWS Mobile Hub project.
  - state (string) –
    
    Synchronization state for a project.
  - createdDate (datetime) –
    
    Date the project was created.
  - lastUpdatedDate (datetime) –
    
    Date of the last modification of the project.
  - consoleUrl (string) –
    
    Website URL for this project in the AWS Mobile Hub console.
  - resources (list) –
    
    List of AWS resources associated with a project.
    - (dict) –
      
      Information about an instance of an AWS resource associated with a project.
      - type (string) –
        
        Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
      - name (string) –
        
        Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
      - arn (string) –
        
        AWS resource name which uniquely identifies the resource in AWS systems.
      - feature (string) –
        
        Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
      - attributes (dict) –
        
        Key-value attribute pairs.
        
        (string) –
        
        Key part of key-value attribute pairs.
        
        (string) –
        
        Value part of key-value attribute pairs.

Exceptions

Mobile.Client.exceptions.InternalFailureException
Mobile.Client.exceptions.ServiceUnavailableException
Mobile.Client.exceptions.UnauthorizedException
Mobile.Client.exceptions.TooManyRequestsException
Mobile.Client.exceptions.BadRequestException
Mobile.Client.exceptions.NotFoundException