CodeCatalyst

Client

class CodeCatalyst.Client

A low-level client representing Amazon CodeCatalyst

Note

Amazon CodeCatalyst is in preview release and subject to change.

Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.

Dev Environments and the Amazon Web Services Toolkits, by calling the following:

  • CreateAccessToken, which creates a personal access token (PAT) for the current user.
  • CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
  • CreateProject which creates a project in a specified space.
  • CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
  • DeleteDevEnvironment, which deletes a Dev Environment.
  • GetDevEnvironment, which returns information about a Dev Environment.
  • GetProject, which returns information about a project.
  • GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
  • GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
  • GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
  • ListDevEnvironments, which retrives a list of Dev Environments in a project.
  • ListProjects, which retrieves a list of projects in a space.
  • ListSourceRepositories, which retrieves a list of source repositories in a project.
  • ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
  • ListSpaces, which retrieves a list of spaces.
  • StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
  • StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
  • StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
  • UpdateDevEnvironment, which changes one or more values for a Dev Environment.
  • VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:

  • DeleteAccessToken, which deletes a specified personal access token (PAT).
  • ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
  • ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
client = session.create_client('codecatalyst')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_access_token(**kwargs)

Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user account. You use PATs to access Amazon CodeCatalyst resources such as source repositories from third-party applications like Git and integrated development environments (IDEs). For more information, see Managing personal access tokens in Amazon CodeCatalyst.

See also: AWS API Documentation

Request Syntax

response = client.create_access_token(
    name='string',
    expiresTime=datetime(2015, 1, 1)
)
Parameters
  • name (string) --

    [REQUIRED]

    The friendly name of the personal access token.

  • expiresTime (datetime) -- The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
Return type

dict

Returns

Response Syntax

{
    'secret': 'string',
    'name': 'string',
    'expiresTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • secret (string) --

      The secret value of the personal access token.

    • name (string) --

      The friendly name of the personal access token.

    • expiresTime (datetime) --

      The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.

Exceptions

create_dev_environment(**kwargs)

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development Dev Environment that you can use to quickly work on the code stored in the source repositories of your project. By default, a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage.

See also: AWS API Documentation

Request Syntax

response = client.create_dev_environment(
    spaceName='string',
    projectName='string',
    repositories=[
        {
            'repositoryName': 'string',
            'branchName': 'string'
        },
    ],
    clientToken='string',
    alias='string',
    ides=[
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    instanceType='dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    inactivityTimeoutMinutes=123,
    persistentStorage={
        'sizeInGiB': 123
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • repositories (list) --

    The source repository that contains the branch to clone into the Dev Environment.

    • (dict) --

      Information about a repository that will be cloned to a Dev Environment.

      • repositoryName (string) -- [REQUIRED]

        The name of the source repository.

      • branchName (string) --

        The name of the branch in a source repository.

  • clientToken (string) -- A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
  • alias (string) -- The user-defined alias for a Dev Environment.
  • ides (list) --

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    Note

    An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

    • (dict) --

      Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

      • runtime (string) --

        A link to the IDE runtime image.

      • name (string) --

        The name of the IDE.

  • instanceType (string) --

    [REQUIRED]

    The Amazon EC2 instace type to use for the Dev Environment.

  • inactivityTimeoutMinutes (integer) -- The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
  • persistentStorage (dict) --

    [REQUIRED]

    Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

    Note

    Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

    • sizeInGiB (integer) -- [REQUIRED]

      The size of the persistent storage in gigabytes (specifically GiB).

      Note

      Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

Exceptions

create_project(**kwargs)

Creates a project in a specified space.

See also: AWS API Documentation

Request Syntax

response = client.create_project(
    spaceName='string',
    displayName='string',
    description='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • displayName (string) --

    [REQUIRED]

    The friendly name of the project that will be displayed to users.

  • description (string) -- The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.
Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'name': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • name (string) --

      The name of the project in the space.

    • displayName (string) --

      The friendly name of the project.

    • description (string) --

      The description of the project.

Exceptions

create_source_repository_branch(**kwargs)

Creates a branch in a specified source repository in Amazon CodeCatalyst.

Note

This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.

See also: AWS API Documentation

Request Syntax

response = client.create_source_repository_branch(
    spaceName='string',
    projectName='string',
    sourceRepositoryName='string',
    name='string',
    headCommitId='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • sourceRepositoryName (string) --

    [REQUIRED]

    The name of the repository where you want to create a branch.

  • name (string) --

    [REQUIRED]

    The name for the branch you're creating.

  • headCommitId (string) -- The commit ID in an existing branch from which you want to create the new branch.
Return type

dict

Returns

Response Syntax

{
    'ref': 'string',
    'name': 'string',
    'lastUpdatedTime': datetime(2015, 1, 1),
    'headCommitId': 'string'
}

Response Structure

  • (dict) --

    • ref (string) --

      The Git reference name of the branch.

    • name (string) --

      The name of the newly created branch.

    • lastUpdatedTime (datetime) --

      The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • headCommitId (string) --

      The commit ID of the tip of the newly created branch.

Exceptions

delete_access_token(**kwargs)

Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.

See also: AWS API Documentation

Request Syntax

response = client.delete_access_token(
    id='string'
)
Parameters
id (string) --

[REQUIRED]

The ID of the personal access token to delete. You can find the IDs of all PATs associated with your user account by calling ListAccessTokens.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_dev_environment(**kwargs)

Deletes a Dev Environment.

See also: AWS API Documentation

Request Syntax

response = client.delete_dev_environment(
    spaceName='string',
    projectName='string',
    id='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the deleted Dev Environment.

Exceptions

get_dev_environment(**kwargs)

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

See also: AWS API Documentation

Request Syntax

response = client.get_dev_environment(
    spaceName='string',
    projectName='string',
    id='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'lastUpdatedTime': datetime(2015, 1, 1),
    'creatorId': 'string',
    'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
    'statusReason': 'string',
    'repositories': [
        {
            'repositoryName': 'string',
            'branchName': 'string'
        },
    ],
    'alias': 'string',
    'ides': [
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    'instanceType': 'dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    'inactivityTimeoutMinutes': 123,
    'persistentStorage': {
        'sizeInGiB': 123
    }
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

    • lastUpdatedTime (datetime) --

      The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • creatorId (string) --

      The system-generated unique ID of the user who created the Dev Environment.

    • status (string) --

      The current status of the Dev Environment.

    • statusReason (string) --

      The reason for the status.

    • repositories (list) --

      The source repository that contains the branch cloned into the Dev Environment.

      • (dict) --

        Information about the source repsitory for a Dev Environment.

        • repositoryName (string) --

          The name of the source repository.

        • branchName (string) --

          The name of the branch in a source repository cloned into the Dev Environment.

    • alias (string) --

      The user-specified alias for the Dev Environment.

    • ides (list) --

      Information about the integrated development environment (IDE) configured for the Dev Environment.

      • (dict) --

        Information about an integrated development environment (IDE) used in a Dev Environment.

        • runtime (string) --

          A link to the IDE runtime image.

        • name (string) --

          The name of the IDE.

    • instanceType (string) --

      The Amazon EC2 instace type to use for the Dev Environment.

    • inactivityTimeoutMinutes (integer) --

      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

    • persistentStorage (dict) --

      Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

      • sizeInGiB (integer) --

        The size of the persistent storage in gigabytes (specifically GiB).

        Note

        Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_project(**kwargs)

Returns information about a project.

See also: AWS API Documentation

Request Syntax

response = client.get_project(
    spaceName='string',
    name='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • name (string) --

    [REQUIRED]

    The name of the project in the space.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'name': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • name (string) --

      The name of the project in the space.

    • displayName (string) --

      The friendly name of the project displayed to users in Amazon CodeCatalyst.

    • description (string) --

      The description of the project.

Exceptions

get_source_repository_clone_urls(**kwargs)

Returns information about the URLs that can be used with a Git client to clone a source repository.

See also: AWS API Documentation

Request Syntax

response = client.get_source_repository_clone_urls(
    spaceName='string',
    projectName='string',
    sourceRepositoryName='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • sourceRepositoryName (string) --

    [REQUIRED]

    The name of the source repository.

Return type

dict

Returns

Response Syntax

{
    'https': 'string'
}

Response Structure

  • (dict) --

    • https (string) --

      The HTTPS URL to use when cloning the source repository.

Exceptions

get_space(**kwargs)

Returns information about an space.

See also: AWS API Documentation

Request Syntax

response = client.get_space(
    name='string'
)
Parameters
name (string) --

[REQUIRED]

The name of the space.

Return type
dict
Returns
Response Syntax
{
    'name': 'string',
    'regionName': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) --
    • name (string) --

      The name of the space.

    • regionName (string) --

      The Amazon Web Services Region where the space exists.

    • displayName (string) --

      The friendly name of the space displayed to users.

    • description (string) --

      The description of the space.

Exceptions

get_subscription(**kwargs)

Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.

See also: AWS API Documentation

Request Syntax

response = client.get_subscription(
    spaceName='string'
)
Parameters
spaceName (string) --

[REQUIRED]

The name of the space.

Return type
dict
Returns
Response Syntax
{
    'subscriptionType': 'string',
    'awsAccountName': 'string'
}

Response Structure

  • (dict) --
    • subscriptionType (string) --

      The type of the billing plan for the space.

    • awsAccountName (string) --

      The display name of the Amazon Web Services account used for billing for the space.

Exceptions

get_user_details(**kwargs)

Returns information about a user.

See also: AWS API Documentation

Request Syntax

response = client.get_user_details(
    id='string',
    userName='string'
)
Parameters
  • id (string) -- The system-generated unique ID of the user.
  • userName (string) -- The name of the user as displayed in Amazon CodeCatalyst.
Return type

dict

Returns

Response Syntax

{
    'userId': 'string',
    'userName': 'string',
    'displayName': 'string',
    'primaryEmail': {
        'email': 'string',
        'verified': True|False
    },
    'version': 'string'
}

Response Structure

  • (dict) --

    • userId (string) --

      The system-generated unique ID of the user.

    • userName (string) --

      The name of the user as displayed in Amazon CodeCatalyst.

    • displayName (string) --

      The friendly name displayed for the user in Amazon CodeCatalyst.

    • primaryEmail (dict) --

      The email address provided by the user when they signed up.

      • email (string) --

        The email address.

      • verified (boolean) --

        Whether the email address has been verified.

    • version (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_access_tokens(**kwargs)

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your user account.

See also: AWS API Documentation

Request Syntax

response = client.list_access_tokens(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'expiresTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      A list of personal access tokens (PATs) associated with the calling user.

      • (dict) --

        Information about a specified personal access token (PAT).

        • id (string) --

          The system-generated ID of the personal access token.

        • name (string) --

          The friendly name of the personal access token.

        • expiresTime (datetime) --

          The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Exceptions

list_dev_environments(**kwargs)

Retrives a list of Dev Environments in a project.

See also: AWS API Documentation

Request Syntax

response = client.list_dev_environments(
    spaceName='string',
    projectName='string',
    filters=[
        {
            'key': 'string',
            'values': [
                'string',
            ],
            'comparisonOperator': 'string'
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • filters (list) --

    Information about filters to apply to narrow the results returned in the list.

    • (dict) --
      • key (string) -- [REQUIRED]
      • values (list) -- [REQUIRED]
        • (string) --
      • comparisonOperator (string) --
  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'spaceName': 'string',
            'projectName': 'string',
            'id': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'creatorId': 'string',
            'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
            'statusReason': 'string',
            'repositories': [
                {
                    'repositoryName': 'string',
                    'branchName': 'string'
                },
            ],
            'alias': 'string',
            'ides': [
                {
                    'runtime': 'string',
                    'name': 'string'
                },
            ],
            'instanceType': 'dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
            'inactivityTimeoutMinutes': 123,
            'persistentStorage': {
                'sizeInGiB': 123
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the Dev Environments in a project.

      • (dict) --

        Information about a Dev Environment.

        • spaceName (string) --

          The name of the space.

        • projectName (string) --

          The name of the project in the space.

        • id (string) --

          The system-generated unique ID for the Dev Environment.

        • lastUpdatedTime (datetime) --

          The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • creatorId (string) --

          The system-generated unique ID of the user who created the Dev Environment.

        • status (string) --

          The status of the Dev Environment.

        • statusReason (string) --

          The reason for the status.

        • repositories (list) --

          Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

          • (dict) --

            Information about the source repsitory for a Dev Environment.

            • repositoryName (string) --

              The name of the source repository.

            • branchName (string) --

              The name of the branch in a source repository cloned into the Dev Environment.

        • alias (string) --

          The user-specified alias for the Dev Environment.

        • ides (list) --

          Information about the integrated development environment (IDE) configured for a Dev Environment.

          • (dict) --

            Information about an integrated development environment (IDE) used in a Dev Environment.

            • runtime (string) --

              A link to the IDE runtime image.

            • name (string) --

              The name of the IDE.

        • instanceType (string) --

          The Amazon EC2 instace type used for the Dev Environment.

        • inactivityTimeoutMinutes (integer) --

          The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

        • persistentStorage (dict) --

          Information about the configuration of persistent storage for the Dev Environment.

          • sizeInGiB (integer) --

            The size of the persistent storage in gigabytes (specifically GiB).

            Note

            Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Exceptions

list_event_logs(**kwargs)

Retrieves a list of events that occurred during a specified time period in a space. You can use these events to audit user and system activity in a space.

See also: AWS API Documentation

Request Syntax

response = client.list_event_logs(
    spaceName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    eventName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • startTime (datetime) --

    [REQUIRED]

    The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • endTime (datetime) --

    [REQUIRED]

    The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • eventName (string) -- The name of the event.
  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'id': 'string',
            'eventName': 'string',
            'eventType': 'string',
            'eventCategory': 'string',
            'eventSource': 'string',
            'eventTime': datetime(2015, 1, 1),
            'operationType': 'READONLY'|'MUTATION',
            'userIdentity': {
                'userType': 'USER'|'AWS_ACCOUNT'|'UNKNOWN',
                'principalId': 'string',
                'userName': 'string',
                'awsAccountId': 'string'
            },
            'projectInformation': {
                'name': 'string',
                'projectId': 'string'
            },
            'requestId': 'string',
            'requestPayload': {
                'contentType': 'string',
                'data': 'string'
            },
            'responsePayload': {
                'contentType': 'string',
                'data': 'string'
            },
            'errorCode': 'string',
            'sourceIpAddress': 'string',
            'userAgent': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items (list) --

      Information about each event retrieved in the list.

      • (dict) --

        Information about an entry in an event log of Amazon CodeCatalyst activity.

        • id (string) --

          The system-generated unique ID of the event.

        • eventName (string) --

          The name of the event.

        • eventType (string) --

          The type of the event.

        • eventCategory (string) --

          The category for the event.

        • eventSource (string) --

          The source of the event.

        • eventTime (datetime) --

          The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • operationType (string) --

          The type of the event.

        • userIdentity (dict) --

          The system-generated unique ID of the user whose actions are recorded in the event.

          • userType (string) --

            The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.

          • principalId (string) --

          • userName (string) --

            The display name of the user in Amazon CodeCatalyst.

          • awsAccountId (string) --

            The Amazon Web Services account number of the user in Amazon Web Services, if any.

        • projectInformation (dict) --

          Information about the project where the event occurred.

          • name (string) --

            The name of the project in the space.

          • projectId (string) --

            The system-generated unique ID of the project.

        • requestId (string) --

          The system-generated unique ID of the request.

        • requestPayload (dict) --

          Information about the payload of the request.

          • contentType (string) --

            The type of content in the event payload.

          • data (string) --

            The data included in the event payload.

        • responsePayload (dict) --

          Information about the payload of the response, if any.

          • contentType (string) --

            The type of content in the event payload.

          • data (string) --

            The data included in the event payload.

        • errorCode (string) --

          The code of the error, if any.

        • sourceIpAddress (string) --

          The IP address of the user whose actions are recorded in the event.

        • userAgent (string) --

Exceptions

list_projects(**kwargs)

Retrieves a list of projects.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    spaceName='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'key': 'hasAccessTo',
            'values': [
                'string',
            ],
            'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'
        },
    ]
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
  • filters (list) --

    Information about filters to apply to narrow the results returned in the list.

    • (dict) --

      nformation about the filter used to narrow the results returned in a list of projects.

      • key (string) -- [REQUIRED]

        A key that can be used to sort results.

      • values (list) -- [REQUIRED]

        The value of the key.

        • (string) --
      • comparisonOperator (string) --

        The operator used to compare the fields.

Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'name': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items (list) --

      Information about the projects.

      • (dict) --

        Information about a project.

        • name (string) --

          The name of the project in the space.

        • displayName (string) --

          The friendly name displayed to users of the project in Amazon CodeCatalyst.

        • description (string) --

          The description of the project.

Exceptions

list_source_repositories(**kwargs)

Retrieves a list of source repositories in a project.

See also: AWS API Documentation

Request Syntax

response = client.list_source_repositories(
    spaceName='string',
    projectName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'createdTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the source repositories.

      • (dict) --

        Information about a source repository returned in a list of source repositories.

        • id (string) --

          The system-generated unique ID of the source repository.

        • name (string) --

          The name of the source repository.

        • description (string) --

          The description of the repository, if any.

        • lastUpdatedTime (datetime) --

          The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • createdTime (datetime) --

          The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

Exceptions

list_source_repository_branches(**kwargs)

Retrieves a list of branches in a specified source repository.

See also: AWS API Documentation

Request Syntax

response = client.list_source_repository_branches(
    spaceName='string',
    projectName='string',
    sourceRepositoryName='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • sourceRepositoryName (string) --

    [REQUIRED]

    The name of the source repository.

  • nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
  • maxResults (integer) -- The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'ref': 'string',
            'name': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'headCommitId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items (list) --

      Information about the source branches.

      • (dict) --

        Information about a branch of a source repository returned in a list of branches.

        • ref (string) --

          The Git reference name of the branch.

        • name (string) --

          The name of the branch.

        • lastUpdatedTime (datetime) --

          The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • headCommitId (string) --

          The commit ID of the tip of the branch at the time of the request, also known as the head commit.

Exceptions

list_spaces(**kwargs)

Retrieves a list of spaces.

See also: AWS API Documentation

Request Syntax

response = client.list_spaces(
    nextToken='string'
)
Parameters
nextToken (string) -- A token returned from a call to this API to indicate the next batch of results to return, if any.
Return type
dict
Returns
Response Syntax
{
    'nextToken': 'string',
    'items': [
        {
            'name': 'string',
            'regionName': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • nextToken (string) --

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items (list) --

      Information about the space.

      • (dict) --

        Information about an space.

        • name (string) --
          We need to know what this is and the basic usage information so that third-party developers know how to use this data type.
        • regionName (string) --

          The Amazon Web Services Region where the space exists.

        • displayName (string) --

          The friendly name of the space displayed to users.

        • description (string) --

          The description of the space.

Exceptions

start_dev_environment(**kwargs)

Starts a specified Dev Environment and puts it into an active state.

See also: AWS API Documentation

Request Syntax

response = client.start_dev_environment(
    spaceName='string',
    projectName='string',
    id='string',
    ides=[
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    instanceType='dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    inactivityTimeoutMinutes=123
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

  • ides (list) --

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    • (dict) --

      Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

      • runtime (string) --

        A link to the IDE runtime image.

      • name (string) --

        The name of the IDE.

  • instanceType (string) -- The Amazon EC2 instace type to use for the Dev Environment.
  • inactivityTimeoutMinutes (integer) -- The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.
Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

    • status (string) --

      The status of the Dev Environment.

Exceptions

start_dev_environment_session(**kwargs)

Starts a session for a specified Dev Environment.

See also: AWS API Documentation

Request Syntax

response = client.start_dev_environment_session(
    spaceName='string',
    projectName='string',
    id='string',
    sessionConfiguration={
        'sessionType': 'SSM'|'SSH',
        'executeCommandSessionConfiguration': {
            'command': 'string',
            'arguments': [
                'string',
            ]
        }
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

  • sessionConfiguration (dict) --

    [REQUIRED]

    Information about the configuration of a Dev Environment session.

    • sessionType (string) -- [REQUIRED]

      The type of the session.

    • executeCommandSessionConfiguration (dict) --

      Information about optional commands that will be run on the Dev Environment when the SSH session begins.

      • command (string) -- [REQUIRED]

        The command used at the beginning of the SSH session to a Dev Environment.

      • arguments (list) --

        An array of arguments containing arguments and members.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'accessDetails': {
        'streamUrl': 'string',
        'tokenValue': 'string'
    },
    'sessionId': 'string',
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string'
}

Response Structure

  • (dict) --

    • accessDetails (dict) --

      Information about connection details for a Dev Environment.

      • streamUrl (string) --

        The URL used to send commands to and from the Dev Environment.

      • tokenValue (string) --

        An encrypted token value that contains session and caller information used to authenticate the connection.

    • sessionId (string) --

      The system-generated unique ID of the Dev Environment session.

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

Exceptions

stop_dev_environment(**kwargs)

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

See also: AWS API Documentation

Request Syntax

response = client.stop_dev_environment(
    spaceName='string',
    projectName='string',
    id='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

Return type

dict

Returns

Response Syntax

{
    'spaceName': 'string',
    'projectName': 'string',
    'id': 'string',
    'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED'
}

Response Structure

  • (dict) --

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • id (string) --

      The system-generated unique ID of the Dev Environment.

    • status (string) --

      The status of the Dev Environment.

Exceptions

update_dev_environment(**kwargs)

Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.

See also: AWS API Documentation

Request Syntax

response = client.update_dev_environment(
    spaceName='string',
    projectName='string',
    id='string',
    alias='string',
    ides=[
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    instanceType='dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    inactivityTimeoutMinutes=123,
    clientToken='string'
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • id (string) --

    [REQUIRED]

    The system-generated unique ID of the Dev Environment.

  • alias (string) -- The user-specified alias for the Dev Environment. Changing this value will not cause a restart.
  • ides (list) --

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    • (dict) --

      Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

      • runtime (string) --

        A link to the IDE runtime image.

      • name (string) --

        The name of the IDE.

  • instanceType (string) --

    The Amazon EC2 instace type to use for the Dev Environment.

    Note

    Changing this value will cause a restart of the Dev Environment if it is running.

  • inactivityTimeoutMinutes (integer) --

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

    Note

    Changing this value will cause a restart of the Dev Environment if it is running.

  • clientToken (string) -- A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.
Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'spaceName': 'string',
    'projectName': 'string',
    'alias': 'string',
    'ides': [
        {
            'runtime': 'string',
            'name': 'string'
        },
    ],
    'instanceType': 'dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
    'inactivityTimeoutMinutes': 123,
    'clientToken': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      The system-generated unique ID of the Dev Environment.

    • spaceName (string) --

      The name of the space.

    • projectName (string) --

      The name of the project in the space.

    • alias (string) --

      The user-specified alias for the Dev Environment.

    • ides (list) --

      Information about the integrated development environment (IDE) configured for the Dev Environment.

      • (dict) --

        Information about the configuration of an integrated development environment (IDE) for a Dev Environment.

        • runtime (string) --

          A link to the IDE runtime image.

        • name (string) --

          The name of the IDE.

    • instanceType (string) --

      The Amazon EC2 instace type to use for the Dev Environment.

    • inactivityTimeoutMinutes (integer) --

      The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

    • clientToken (string) --

      A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

Exceptions

verify_session()

Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.

See also: AWS API Documentation

Request Syntax

response = client.verify_session()
Return type
dict
Returns
Response Syntax
{
    'identity': 'string'
}

Response Structure

  • (dict) --
    • identity (string) --

      The system-generated unique ID of the user in Amazon CodeCatalyst.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class CodeCatalyst.Client.exceptions.AccessDeniedException

The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeCatalyst.Client.exceptions.ConflictException

The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeCatalyst.Client.exceptions.ResourceNotFoundException

The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeCatalyst.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class CodeCatalyst.Client.exceptions.ValidationException

The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class CodeCatalyst.Paginator.ListAccessTokens
paginator = client.get_paginator('list_access_tokens')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_access_tokens().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'expiresTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • items (list) --

      A list of personal access tokens (PATs) associated with the calling user.

      • (dict) --

        Information about a specified personal access token (PAT).

        • id (string) --

          The system-generated ID of the personal access token.

        • name (string) --

          The friendly name of the personal access token.

        • expiresTime (datetime) --

          The date and time when the personal access token will expire, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListDevEnvironments
paginator = client.get_paginator('list_dev_environments')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_dev_environments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    filters=[
        {
            'key': 'string',
            'values': [
                'string',
            ],
            'comparisonOperator': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • filters (list) --

    Information about filters to apply to narrow the results returned in the list.

    • (dict) --
      • key (string) -- [REQUIRED]
      • values (list) -- [REQUIRED]
        • (string) --
      • comparisonOperator (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'spaceName': 'string',
            'projectName': 'string',
            'id': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'creatorId': 'string',
            'status': 'PENDING'|'RUNNING'|'STARTING'|'STOPPING'|'STOPPED'|'FAILED'|'DELETING'|'DELETED',
            'statusReason': 'string',
            'repositories': [
                {
                    'repositoryName': 'string',
                    'branchName': 'string'
                },
            ],
            'alias': 'string',
            'ides': [
                {
                    'runtime': 'string',
                    'name': 'string'
                },
            ],
            'instanceType': 'dev.standard1.small'|'dev.standard1.medium'|'dev.standard1.large'|'dev.standard1.xlarge',
            'inactivityTimeoutMinutes': 123,
            'persistentStorage': {
                'sizeInGiB': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the Dev Environments in a project.

      • (dict) --

        Information about a Dev Environment.

        • spaceName (string) --

          The name of the space.

        • projectName (string) --

          The name of the project in the space.

        • id (string) --

          The system-generated unique ID for the Dev Environment.

        • lastUpdatedTime (datetime) --

          The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • creatorId (string) --

          The system-generated unique ID of the user who created the Dev Environment.

        • status (string) --

          The status of the Dev Environment.

        • statusReason (string) --

          The reason for the status.

        • repositories (list) --

          Information about the repositories that will be cloned into the Dev Environment. If no rvalue is specified, no repository is cloned.

          • (dict) --

            Information about the source repsitory for a Dev Environment.

            • repositoryName (string) --

              The name of the source repository.

            • branchName (string) --

              The name of the branch in a source repository cloned into the Dev Environment.

        • alias (string) --

          The user-specified alias for the Dev Environment.

        • ides (list) --

          Information about the integrated development environment (IDE) configured for a Dev Environment.

          • (dict) --

            Information about an integrated development environment (IDE) used in a Dev Environment.

            • runtime (string) --

              A link to the IDE runtime image.

            • name (string) --

              The name of the IDE.

        • instanceType (string) --

          The Amazon EC2 instace type used for the Dev Environment.

        • inactivityTimeoutMinutes (integer) --

          The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Dev Environments consume compute minutes when running.

        • persistentStorage (dict) --

          Information about the configuration of persistent storage for the Dev Environment.

          • sizeInGiB (integer) --

            The size of the persistent storage in gigabytes (specifically GiB).

            Note

            Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListEventLogs
paginator = client.get_paginator('list_event_logs')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_event_logs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    eventName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • startTime (datetime) --

    [REQUIRED]

    The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • endTime (datetime) --

    [REQUIRED]

    The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • eventName (string) -- The name of the event.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'eventName': 'string',
            'eventType': 'string',
            'eventCategory': 'string',
            'eventSource': 'string',
            'eventTime': datetime(2015, 1, 1),
            'operationType': 'READONLY'|'MUTATION',
            'userIdentity': {
                'userType': 'USER'|'AWS_ACCOUNT'|'UNKNOWN',
                'principalId': 'string',
                'userName': 'string',
                'awsAccountId': 'string'
            },
            'projectInformation': {
                'name': 'string',
                'projectId': 'string'
            },
            'requestId': 'string',
            'requestPayload': {
                'contentType': 'string',
                'data': 'string'
            },
            'responsePayload': {
                'contentType': 'string',
                'data': 'string'
            },
            'errorCode': 'string',
            'sourceIpAddress': 'string',
            'userAgent': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about each event retrieved in the list.

      • (dict) --

        Information about an entry in an event log of Amazon CodeCatalyst activity.

        • id (string) --

          The system-generated unique ID of the event.

        • eventName (string) --

          The name of the event.

        • eventType (string) --

          The type of the event.

        • eventCategory (string) --

          The category for the event.

        • eventSource (string) --

          The source of the event.

        • eventTime (datetime) --

          The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • operationType (string) --

          The type of the event.

        • userIdentity (dict) --

          The system-generated unique ID of the user whose actions are recorded in the event.

          • userType (string) --

            The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred.

          • principalId (string) --

          • userName (string) --

            The display name of the user in Amazon CodeCatalyst.

          • awsAccountId (string) --

            The Amazon Web Services account number of the user in Amazon Web Services, if any.

        • projectInformation (dict) --

          Information about the project where the event occurred.

          • name (string) --

            The name of the project in the space.

          • projectId (string) --

            The system-generated unique ID of the project.

        • requestId (string) --

          The system-generated unique ID of the request.

        • requestPayload (dict) --

          Information about the payload of the request.

          • contentType (string) --

            The type of content in the event payload.

          • data (string) --

            The data included in the event payload.

        • responsePayload (dict) --

          Information about the payload of the response, if any.

          • contentType (string) --

            The type of content in the event payload.

          • data (string) --

            The data included in the event payload.

        • errorCode (string) --

          The code of the error, if any.

        • sourceIpAddress (string) --

          The IP address of the user whose actions are recorded in the event.

        • userAgent (string) --

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListProjects
paginator = client.get_paginator('list_projects')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_projects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    filters=[
        {
            'key': 'hasAccessTo',
            'values': [
                'string',
            ],
            'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • filters (list) --

    Information about filters to apply to narrow the results returned in the list.

    • (dict) --

      nformation about the filter used to narrow the results returned in a list of projects.

      • key (string) -- [REQUIRED]

        A key that can be used to sort results.

      • values (list) -- [REQUIRED]

        The value of the key.

        • (string) --
      • comparisonOperator (string) --

        The operator used to compare the fields.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'name': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the projects.

      • (dict) --

        Information about a project.

        • name (string) --

          The name of the project in the space.

        • displayName (string) --

          The friendly name displayed to users of the project in Amazon CodeCatalyst.

        • description (string) --

          The description of the project.

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListSourceRepositories
paginator = client.get_paginator('list_source_repositories')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_source_repositories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'createdTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the source repositories.

      • (dict) --

        Information about a source repository returned in a list of source repositories.

        • id (string) --

          The system-generated unique ID of the source repository.

        • name (string) --

          The name of the source repository.

        • description (string) --

          The description of the repository, if any.

        • lastUpdatedTime (datetime) --

          The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • createdTime (datetime) --

          The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListSourceRepositoryBranches
paginator = client.get_paginator('list_source_repository_branches')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_source_repository_branches().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    spaceName='string',
    projectName='string',
    sourceRepositoryName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • spaceName (string) --

    [REQUIRED]

    The name of the space.

  • projectName (string) --

    [REQUIRED]

    The name of the project in the space.

  • sourceRepositoryName (string) --

    [REQUIRED]

    The name of the source repository.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'ref': 'string',
            'name': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'headCommitId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      Information about the source branches.

      • (dict) --

        Information about a branch of a source repository returned in a list of branches.

        • ref (string) --

          The Git reference name of the branch.

        • name (string) --

          The name of the branch.

        • lastUpdatedTime (datetime) --

          The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

        • headCommitId (string) --

          The commit ID of the tip of the branch at the time of the request, also known as the head commit.

    • NextToken (string) --

      A token to resume pagination.

class CodeCatalyst.Paginator.ListSpaces
paginator = client.get_paginator('list_spaces')
paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeCatalyst.Client.list_spaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'items': [
        {
            'name': 'string',
            'regionName': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • items (list) --

      Information about the space.

      • (dict) --

        Information about an space.

        • name (string) --
          We need to know what this is and the basic usage information so that third-party developers know how to use this data type.
        • regionName (string) --

          The Amazon Web Services Region where the space exists.

        • displayName (string) --

          The friendly name of the space displayed to users.

        • description (string) --

          The description of the space.

    • NextToken (string) --

      A token to resume pagination.