SDK for PHP 3.x

Amazon CodeCatalyst 2022-09-28

Client: Aws\CodeCatalyst\CodeCatalystClient
Service ID: codecatalyst
Version: 2022-09-28

This page describes the parameters and results for the operations of the Amazon CodeCatalyst (2022-09-28), and shows how to use the Aws\CodeCatalyst\CodeCatalystClient object to call the described operations. This documentation is specific to the 2022-09-28 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAccessToken ( array $params = [] )
Creates a personal access token (PAT) for the current user.
CreateDevEnvironment ( array $params = [] )
Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
CreateProject ( array $params = [] )
Creates a project in a specified space.
CreateSourceRepository ( array $params = [] )
Creates an empty Git-based source repository in a specified project.
CreateSourceRepositoryBranch ( array $params = [] )
Creates a branch in a specified source repository in Amazon CodeCatalyst.
DeleteAccessToken ( array $params = [] )
Deletes a specified personal access token (PAT).
DeleteDevEnvironment ( array $params = [] )
Deletes a Dev Environment.
DeleteProject ( array $params = [] )
Deletes a project in a space.
DeleteSourceRepository ( array $params = [] )
Deletes a source repository in Amazon CodeCatalyst.
DeleteSpace ( array $params = [] )
Deletes a space.
GetDevEnvironment ( array $params = [] )
Returns information about a Dev Environment for a source repository in a project.
GetProject ( array $params = [] )
Returns information about a project.
GetSourceRepository ( array $params = [] )
Returns information about a source repository.
GetSourceRepositoryCloneUrls ( array $params = [] )
Returns information about the URLs that can be used with a Git client to clone a source repository.
GetSpace ( array $params = [] )
Returns information about an space.
GetSubscription ( array $params = [] )
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
GetUserDetails ( array $params = [] )
Returns information about a user.
GetWorkflow ( array $params = [] )
Returns information about a workflow.
GetWorkflowRun ( array $params = [] )
Returns information about a specified run of a workflow.
ListAccessTokens ( array $params = [] )
Lists all personal access tokens (PATs) associated with the user who calls the API.
ListDevEnvironmentSessions ( array $params = [] )
Retrieves a list of active sessions for a Dev Environment in a project.
ListDevEnvironments ( array $params = [] )
Retrieves a list of Dev Environments in a project.
ListEventLogs ( array $params = [] )
Retrieves a list of events that occurred during a specific time in a space.
ListProjects ( array $params = [] )
Retrieves a list of projects.
ListSourceRepositories ( array $params = [] )
Retrieves a list of source repositories in a project.
ListSourceRepositoryBranches ( array $params = [] )
Retrieves a list of branches in a specified source repository.
ListSpaces ( array $params = [] )
Retrieves a list of spaces.
ListWorkflowRuns ( array $params = [] )
Retrieves a list of workflow runs of a specified workflow.
ListWorkflows ( array $params = [] )
Retrieves a list of workflows in a specified project.
StartDevEnvironment ( array $params = [] )
Starts a specified Dev Environment and puts it into an active state.
StartDevEnvironmentSession ( array $params = [] )
Starts a session for a specified Dev Environment.
StartWorkflowRun ( array $params = [] )
Begins a run of a specified workflow.
StopDevEnvironment ( array $params = [] )
Pauses a specified Dev Environment and places it in a non-running state.
StopDevEnvironmentSession ( array $params = [] )
Stops a session for a specified Dev Environment.
UpdateDevEnvironment ( array $params = [] )
Changes one or more values for a Dev Environment.
UpdateProject ( array $params = [] )
Changes one or more values for a project.
UpdateSpace ( array $params = [] )
Changes one or more values for a space.
VerifySession ( array $params = [] )
Verifies whether the calling user has a valid Amazon CodeCatalyst login and session.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccessTokens
ListDevEnvironmentSessions
ListDevEnvironments
ListEventLogs
ListProjects
ListSourceRepositories
ListSourceRepositoryBranches
ListSpaces
ListWorkflowRuns
ListWorkflows

Operations

CreateAccessToken 

$result = $client->createAccessToken([/* ... */]);
$promise = $client->createAccessTokenAsync([/* ... */]);

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 identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.

Parameter Syntax

$result = $client->createAccessToken([
    'expiresTime' => <integer || string || DateTime>,
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
expiresTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

name
Required: Yes
Type: string

The friendly name of the personal access token.

Result Syntax

[
    'accessTokenId' => '<string>',
    'expiresTime' => <DateTime>,
    'name' => '<string>',
    'secret' => '<string>',
]

Result Details

Members
accessTokenId
Required: Yes
Type: string

The system-generated unique ID of the access token.

expiresTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

name
Required: Yes
Type: string

The friendly name of the personal access token.

secret
Required: Yes
Type: string

The secret value of the personal access token.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

CreateDevEnvironment 

$result = $client->createDevEnvironment([/* ... */]);
$promise = $client->createDevEnvironmentAsync([/* ... */]);

Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.

When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.

Parameter Syntax

$result = $client->createDevEnvironment([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'ides' => [
        [
            'name' => '<string>',
            'runtime' => '<string>',
        ],
        // ...
    ],
    'inactivityTimeoutMinutes' => <integer>,
    'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge', // REQUIRED
    'persistentStorage' => [ // REQUIRED
        'sizeInGiB' => <integer>, // REQUIRED
    ],
    'projectName' => '<string>', // REQUIRED
    'repositories' => [
        [
            'branchName' => '<string>',
            'repositoryName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'spaceName' => '<string>', // REQUIRED
    'vpcConnectionName' => '<string>',
]);

Parameter Details

Members
alias
Type: string

The user-defined alias for a Dev Environment.

clientToken
Type: 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.

ides
Type: Array of IdeConfiguration structures

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

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

inactivityTimeoutMinutes
Type: int

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.

instanceType
Required: Yes
Type: string

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

persistentStorage
Required: Yes
Type: PersistentStorageConfiguration structure

Information about the amount of storage allocated to the Dev Environment.

By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

projectName
Required: Yes
Type: string

The name of the project in the space.

repositories
Type: Array of RepositoryInput structures

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

spaceName
Required: Yes
Type: string

The name of the space.

vpcConnectionName
Type: string

The name of the connection that will be used to connect to Amazon VPC, if any.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
    'vpcConnectionName' => '<string>',
]

Result Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

vpcConnectionName
Type: string

The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

CreateProject 

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates a project in a specified space.

Parameter Syntax

$result = $client->createProject([
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: 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.

displayName
Required: Yes
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'displayName' => '<string>',
    'name' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
description
Type: string

The description of the project.

displayName
Type: string

The friendly name of the project.

name
Required: Yes
Type: string

The name of the project in the space.

spaceName
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

CreateSourceRepository 

$result = $client->createSourceRepository([/* ... */]);
$promise = $client->createSourceRepositoryAsync([/* ... */]);

Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.

Parameter Syntax

$result = $client->createSourceRepository([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the source repository.

name
Required: Yes
Type: string

The name of the source repository. For more information about name requirements, see Quotas for source repositories.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'name' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
description
Type: string

The description of the source repository.

name
Required: Yes
Type: string

The name of the source repository.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

CreateSourceRepositoryBranch 

$result = $client->createSourceRepositoryBranch([/* ... */]);
$promise = $client->createSourceRepositoryBranchAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->createSourceRepositoryBranch([
    'headCommitId' => '<string>',
    'name' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'sourceRepositoryName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
headCommitId
Type: string

The commit ID in an existing branch from which you want to create the new branch.

name
Required: Yes
Type: string

The name for the branch you're creating.

projectName
Required: Yes
Type: string

The name of the project in the space.

sourceRepositoryName
Required: Yes
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'headCommitId' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
    'ref' => '<string>',
]

Result Details

Members
headCommitId
Type: string

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

lastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

name
Type: string

The name of the newly created branch.

ref
Type: string

The Git reference name of the branch.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

DeleteAccessToken 

$result = $client->deleteAccessToken([/* ... */]);
$promise = $client->deleteAccessTokenAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteAccessToken([
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling ListAccessTokens.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

DeleteDevEnvironment 

$result = $client->deleteDevEnvironment([/* ... */]);
$promise = $client->deleteDevEnvironmentAsync([/* ... */]);

Deletes a Dev Environment.

Parameter Syntax

$result = $client->deleteDevEnvironment([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
id
Required: Yes
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

DeleteProject 

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes a project in a space.

Parameter Syntax

$result = $client->deleteProject([
    'name' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the project in the space. To retrieve a list of project names, use ListProjects.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'displayName' => '<string>',
    'name' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
displayName
Type: string

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

name
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

DeleteSourceRepository 

$result = $client->deleteSourceRepository([/* ... */]);
$promise = $client->deleteSourceRepositoryAsync([/* ... */]);

Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

Parameter Syntax

$result = $client->deleteSourceRepository([
    'name' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the source repository.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'name' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
name
Required: Yes
Type: string

The name of the repository.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

DeleteSpace 

$result = $client->deleteSpace([/* ... */]);
$promise = $client->deleteSpaceAsync([/* ... */]);

Deletes a space.

Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.

Parameter Syntax

$result = $client->deleteSpace([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the space. To retrieve a list of space names, use ListSpaces.

Result Syntax

[
    'displayName' => '<string>',
    'name' => '<string>',
]

Result Details

Members
displayName
Type: string

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

name
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetDevEnvironment 

$result = $client->getDevEnvironment([/* ... */]);
$promise = $client->getDevEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getDevEnvironment([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

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.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'alias' => '<string>',
    'creatorId' => '<string>',
    'id' => '<string>',
    'ides' => [
        [
            'name' => '<string>',
            'runtime' => '<string>',
        ],
        // ...
    ],
    'inactivityTimeoutMinutes' => <integer>,
    'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge',
    'lastUpdatedTime' => <DateTime>,
    'persistentStorage' => [
        'sizeInGiB' => <integer>,
    ],
    'projectName' => '<string>',
    'repositories' => [
        [
            'branchName' => '<string>',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'spaceName' => '<string>',
    'status' => 'PENDING|RUNNING|STARTING|STOPPING|STOPPED|FAILED|DELETING|DELETED',
    'statusReason' => '<string>',
    'vpcConnectionName' => '<string>',
]

Result Details

Members
alias
Type: string

The user-specified alias for the Dev Environment.

creatorId
Required: Yes
Type: string

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

id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

ides
Type: Array of Ide structures

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

inactivityTimeoutMinutes
Required: Yes
Type: int

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

instanceType
Required: Yes
Type: string

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

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

persistentStorage
Required: Yes
Type: PersistentStorage structure

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

projectName
Required: Yes
Type: string

The name of the project in the space.

repositories
Required: Yes
Type: Array of DevEnvironmentRepositorySummary structures

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

spaceName
Required: Yes
Type: string

The name of the space.

status
Required: Yes
Type: string

The current status of the Dev Environment.

statusReason
Type: string

The reason for the status.

vpcConnectionName
Type: string

The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetProject 

$result = $client->getProject([/* ... */]);
$promise = $client->getProjectAsync([/* ... */]);

Returns information about a project.

Parameter Syntax

$result = $client->getProject([
    'name' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'displayName' => '<string>',
    'name' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
description
Type: string

The description of the project.

displayName
Type: string

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

name
Required: Yes
Type: string

The name of the project in the space.

spaceName
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetSourceRepository 

$result = $client->getSourceRepository([/* ... */]);
$promise = $client->getSourceRepositoryAsync([/* ... */]);

Returns information about a source repository.

Parameter Syntax

$result = $client->getSourceRepository([
    'name' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the source repository.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'createdTime' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
createdTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

description
Type: string

The description of the source repository.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

name
Required: Yes
Type: string

The name of the source repository.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetSourceRepositoryCloneUrls 

$result = $client->getSourceRepositoryCloneUrls([/* ... */]);
$promise = $client->getSourceRepositoryCloneUrlsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getSourceRepositoryCloneUrls([
    'projectName' => '<string>', // REQUIRED
    'sourceRepositoryName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
projectName
Required: Yes
Type: string

The name of the project in the space.

sourceRepositoryName
Required: Yes
Type: string

The name of the source repository.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'https' => '<string>',
]

Result Details

Members
https
Required: Yes
Type: string

The HTTPS URL to use when cloning the source repository.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetSpace 

$result = $client->getSpace([/* ... */]);
$promise = $client->getSpaceAsync([/* ... */]);

Returns information about an space.

Parameter Syntax

$result = $client->getSpace([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'displayName' => '<string>',
    'name' => '<string>',
    'regionName' => '<string>',
]

Result Details

Members
description
Type: string

The description of the space.

displayName
Type: string

The friendly name of the space displayed to users.

name
Required: Yes
Type: string

The name of the space.

regionName
Required: Yes
Type: string

The Amazon Web Services Region where the space exists.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetSubscription 

$result = $client->getSubscription([/* ... */]);
$promise = $client->getSubscriptionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getSubscription([
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'awsAccountName' => '<string>',
    'pendingSubscriptionStartTime' => <DateTime>,
    'pendingSubscriptionType' => '<string>',
    'subscriptionType' => '<string>',
]

Result Details

Members
awsAccountName
Type: string

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

pendingSubscriptionStartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

pendingSubscriptionType
Type: string

The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing.

subscriptionType
Type: string

The type of the billing plan for the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetUserDetails 

$result = $client->getUserDetails([/* ... */]);
$promise = $client->getUserDetailsAsync([/* ... */]);

Returns information about a user.

Parameter Syntax

$result = $client->getUserDetails([
    'id' => '<string>',
    'userName' => '<string>',
]);

Parameter Details

Members
id
Type: string

The system-generated unique ID of the user.

userName
Type: string

The name of the user as displayed in Amazon CodeCatalyst.

Result Syntax

[
    'displayName' => '<string>',
    'primaryEmail' => [
        'email' => '<string>',
        'verified' => true || false,
    ],
    'userId' => '<string>',
    'userName' => '<string>',
    'version' => '<string>',
]

Result Details

Members
displayName
Type: string

The friendly name displayed for the user in Amazon CodeCatalyst.

primaryEmail
Type: EmailAddress structure

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

userId
Type: string

The system-generated unique ID of the user.

userName
Type: string

The name of the user as displayed in Amazon CodeCatalyst.

version
Type: string

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetWorkflow 

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Returns information about a workflow.

Parameter Syntax

$result = $client->getWorkflow([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'createdTime' => <DateTime>,
    'definition' => [
        'path' => '<string>',
    ],
    'id' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    'name' => '<string>',
    'projectName' => '<string>',
    'runMode' => 'QUEUED|PARALLEL|SUPERSEDED',
    'sourceBranchName' => '<string>',
    'sourceRepositoryName' => '<string>',
    'spaceName' => '<string>',
    'status' => 'INVALID|ACTIVE',
]

Result Details

Members
createdTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

definition
Required: Yes
Type: WorkflowDefinition structure

Information about the workflow definition file for the workflow.

id
Required: Yes
Type: string

The ID of the workflow.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

name
Required: Yes
Type: string

The name of the workflow.

projectName
Required: Yes
Type: string

The name of the project in the space.

runMode
Required: Yes
Type: string

The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

sourceBranchName
Type: string

The name of the branch that contains the workflow YAML.

sourceRepositoryName
Type: string

The name of the source repository where the workflow YAML is stored.

spaceName
Required: Yes
Type: string

The name of the space.

status
Required: Yes
Type: string

The status of the workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

GetWorkflowRun 

$result = $client->getWorkflowRun([/* ... */]);
$promise = $client->getWorkflowRunAsync([/* ... */]);

Returns information about a specified run of a workflow.

Parameter Syntax

$result = $client->getWorkflowRun([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'endTime' => <DateTime>,
    'id' => '<string>',
    'lastUpdatedTime' => <DateTime>,
    'projectName' => '<string>',
    'spaceName' => '<string>',
    'startTime' => <DateTime>,
    'status' => 'SUCCEEDED|FAILED|STOPPED|SUPERSEDED|CANCELLED|NOT_RUN|VALIDATING|PROVISIONING|IN_PROGRESS|STOPPING|ABANDONED',
    'statusReasons' => [
        [
        ],
        // ...
    ],
    'workflowId' => '<string>',
]

Result Details

Members
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

id
Required: Yes
Type: string

The ID of the workflow run.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

status
Required: Yes
Type: string

The status of the workflow run.

statusReasons
Type: Array of WorkflowRunStatusReason structures

Information about the reasons for the status of the workflow run.

workflowId
Required: Yes
Type: string

The ID of the workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListAccessTokens 

$result = $client->listAccessTokens([/* ... */]);
$promise = $client->listAccessTokensAsync([/* ... */]);

Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.

Parameter Syntax

$result = $client->listAccessTokens([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

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

Result Syntax

[
    'items' => [
        [
            'expiresTime' => <DateTime>,
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Required: Yes
Type: Array of AccessTokenSummary structures

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

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListDevEnvironmentSessions 

$result = $client->listDevEnvironmentSessions([/* ... */]);
$promise = $client->listDevEnvironmentSessionsAsync([/* ... */]);

Retrieves a list of active sessions for a Dev Environment in a project.

Parameter Syntax

$result = $client->listDevEnvironmentSessions([
    'devEnvironmentId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
devEnvironmentId
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

maxResults
Type: int

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
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'devEnvironmentId' => '<string>',
            'id' => '<string>',
            'projectName' => '<string>',
            'spaceName' => '<string>',
            'startedTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Required: Yes
Type: Array of DevEnvironmentSessionSummary structures

Information about each session retrieved in the list.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListDevEnvironments 

$result = $client->listDevEnvironments([/* ... */]);
$promise = $client->listDevEnvironmentsAsync([/* ... */]);

Retrieves a list of Dev Environments in a project.

Parameter Syntax

$result = $client->listDevEnvironments([
    'filters' => [
        [
            'comparisonOperator' => '<string>',
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
filters
Type: Array of Filter structures

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

maxResults
Type: int

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
Type: string

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

projectName
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'alias' => '<string>',
            'creatorId' => '<string>',
            'id' => '<string>',
            'ides' => [
                [
                    'name' => '<string>',
                    'runtime' => '<string>',
                ],
                // ...
            ],
            'inactivityTimeoutMinutes' => <integer>,
            'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge',
            'lastUpdatedTime' => <DateTime>,
            'persistentStorage' => [
                'sizeInGiB' => <integer>,
            ],
            'projectName' => '<string>',
            'repositories' => [
                [
                    'branchName' => '<string>',
                    'repositoryName' => '<string>',
                ],
                // ...
            ],
            'spaceName' => '<string>',
            'status' => 'PENDING|RUNNING|STARTING|STOPPING|STOPPED|FAILED|DELETING|DELETED',
            'statusReason' => '<string>',
            'vpcConnectionName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Required: Yes
Type: Array of DevEnvironmentSummary structures

Information about the Dev Environments in a project.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListEventLogs 

$result = $client->listEventLogs([/* ... */]);
$promise = $client->listEventLogsAsync([/* ... */]);

Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.

ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.

Parameter Syntax

$result = $client->listEventLogs([
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'eventName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'spaceName' => '<string>', // REQUIRED
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members
endTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

eventName
Type: string

The name of the event.

maxResults
Type: int

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
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Result Syntax

[
    'items' => [
        [
            'errorCode' => '<string>',
            'eventCategory' => '<string>',
            'eventName' => '<string>',
            'eventSource' => '<string>',
            'eventTime' => <DateTime>,
            'eventType' => '<string>',
            'id' => '<string>',
            'operationType' => 'READONLY|MUTATION',
            'projectInformation' => [
                'name' => '<string>',
                'projectId' => '<string>',
            ],
            'requestId' => '<string>',
            'requestPayload' => [
                'contentType' => '<string>',
                'data' => '<string>',
            ],
            'responsePayload' => [
                'contentType' => '<string>',
                'data' => '<string>',
            ],
            'sourceIpAddress' => '<string>',
            'userAgent' => '<string>',
            'userIdentity' => [
                'awsAccountId' => '<string>',
                'principalId' => '<string>',
                'userName' => '<string>',
                'userType' => 'USER|AWS_ACCOUNT|UNKNOWN',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Required: Yes
Type: Array of EventLogEntry structures

Information about each event retrieved in the list.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListProjects 

$result = $client->listProjects([/* ... */]);
$promise = $client->listProjectsAsync([/* ... */]);

Retrieves a list of projects.

Parameter Syntax

$result = $client->listProjects([
    'filters' => [
        [
            'comparisonOperator' => 'EQ|GT|GE|LT|LE|BEGINS_WITH',
            'key' => 'hasAccessTo|name', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
filters
Type: Array of ProjectListFilter structures

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

maxResults
Type: int

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
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'description' => '<string>',
            'displayName' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Type: Array of ProjectSummary structures

Information about the projects.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListSourceRepositories 

$result = $client->listSourceRepositories([/* ... */]);
$promise = $client->listSourceRepositoriesAsync([/* ... */]);

Retrieves a list of source repositories in a project.

Parameter Syntax

$result = $client->listSourceRepositories([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Type: Array of ListSourceRepositoriesItem structures

Information about the source repositories.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListSourceRepositoryBranches 

$result = $client->listSourceRepositoryBranches([/* ... */]);
$promise = $client->listSourceRepositoryBranchesAsync([/* ... */]);

Retrieves a list of branches in a specified source repository.

Parameter Syntax

$result = $client->listSourceRepositoryBranches([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'sourceRepositoryName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

sourceRepositoryName
Required: Yes
Type: string

The name of the source repository.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'headCommitId' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'ref' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Required: Yes
Type: Array of ListSourceRepositoryBranchesItem structures

Information about the source branches.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListSpaces 

$result = $client->listSpaces([/* ... */]);
$promise = $client->listSpacesAsync([/* ... */]);

Retrieves a list of spaces.

Parameter Syntax

$result = $client->listSpaces([
    'nextToken' => '<string>',
]);

Parameter Details

Members
nextToken
Type: string

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

Result Syntax

[
    'items' => [
        [
            'description' => '<string>',
            'displayName' => '<string>',
            'name' => '<string>',
            'regionName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Type: Array of SpaceSummary structures

Information about the spaces.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListWorkflowRuns 

$result = $client->listWorkflowRuns([/* ... */]);
$promise = $client->listWorkflowRunsAsync([/* ... */]);

Retrieves a list of workflow runs of a specified workflow.

Parameter Syntax

$result = $client->listWorkflowRuns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'sortBy' => [
        [
        ],
        // ...
    ],
    'spaceName' => '<string>', // REQUIRED
    'workflowId' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

sortBy
Type: Array of WorkflowRunSortCriteria structures

Information used to sort the items in the returned list.

spaceName
Required: Yes
Type: string

The name of the space.

workflowId
Type: string

The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

Result Syntax

[
    'items' => [
        [
            'endTime' => <DateTime>,
            'id' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'startTime' => <DateTime>,
            'status' => 'SUCCEEDED|FAILED|STOPPED|SUPERSEDED|CANCELLED|NOT_RUN|VALIDATING|PROVISIONING|IN_PROGRESS|STOPPING|ABANDONED',
            'statusReasons' => [
                [
                ],
                // ...
            ],
            'workflowId' => '<string>',
            'workflowName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Type: Array of WorkflowRunSummary structures

Information about the runs of a workflow.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

ListWorkflows 

$result = $client->listWorkflows([/* ... */]);
$promise = $client->listWorkflowsAsync([/* ... */]);

Retrieves a list of workflows in a specified project.

Parameter Syntax

$result = $client->listWorkflows([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'sortBy' => [
        [
        ],
        // ...
    ],
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
maxResults
Type: int

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
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

sortBy
Type: Array of WorkflowSortCriteria structures

Information used to sort the items in the returned list.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'items' => [
        [
            'createdTime' => <DateTime>,
            'definition' => [
                'path' => '<string>',
            ],
            'id' => '<string>',
            'lastUpdatedTime' => <DateTime>,
            'name' => '<string>',
            'runMode' => 'QUEUED|PARALLEL|SUPERSEDED',
            'sourceBranchName' => '<string>',
            'sourceRepositoryName' => '<string>',
            'status' => 'INVALID|ACTIVE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
items
Type: Array of WorkflowSummary structures

Information about the workflows in a project.

nextToken
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

StartDevEnvironment 

$result = $client->startDevEnvironment([/* ... */]);
$promise = $client->startDevEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->startDevEnvironment([
    'id' => '<string>', // REQUIRED
    'ides' => [
        [
            'name' => '<string>',
            'runtime' => '<string>',
        ],
        // ...
    ],
    'inactivityTimeoutMinutes' => <integer>,
    'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge',
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

ides
Type: Array of IdeConfiguration structures

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

inactivityTimeoutMinutes
Type: int

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.

instanceType
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
    'status' => 'PENDING|RUNNING|STARTING|STOPPING|STOPPED|FAILED|DELETING|DELETED',
]

Result Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

status
Required: Yes
Type: string

The status of the Dev Environment.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

StartDevEnvironmentSession 

$result = $client->startDevEnvironmentSession([/* ... */]);
$promise = $client->startDevEnvironmentSessionAsync([/* ... */]);

Starts a session for a specified Dev Environment.

Parameter Syntax

$result = $client->startDevEnvironmentSession([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'sessionConfiguration' => [ // REQUIRED
        'executeCommandSessionConfiguration' => [
            'arguments' => ['<string>', ...],
            'command' => '<string>', // REQUIRED
        ],
        'sessionType' => 'SSM|SSH', // REQUIRED
    ],
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

sessionConfiguration
Required: Yes
Type: DevEnvironmentSessionConfiguration structure

Information about the configuration of a Dev Environment session.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'accessDetails' => [
        'streamUrl' => '<string>',
        'tokenValue' => '<string>',
    ],
    'id' => '<string>',
    'projectName' => '<string>',
    'sessionId' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
accessDetails
Required: Yes
Type: DevEnvironmentAccessDetails structure

Information about connection details for a Dev Environment.

id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

sessionId
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

StartWorkflowRun 

$result = $client->startWorkflowRun([/* ... */]);
$promise = $client->startWorkflowRunAsync([/* ... */]);

Begins a run of a specified workflow.

Parameter Syntax

$result = $client->startWorkflowRun([
    'clientToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
    'workflowId' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
Type: 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.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

workflowId
Required: Yes
Type: string

The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
    'workflowId' => '<string>',
]

Result Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the workflow run.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

workflowId
Required: Yes
Type: string

The system-generated unique ID of the workflow.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

StopDevEnvironment 

$result = $client->stopDevEnvironment([/* ... */]);
$promise = $client->stopDevEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->stopDevEnvironment([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'spaceName' => '<string>',
    'status' => 'PENDING|RUNNING|STARTING|STOPPING|STOPPED|FAILED|DELETING|DELETED',
]

Result Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

status
Required: Yes
Type: string

The status of the Dev Environment.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

StopDevEnvironmentSession 

$result = $client->stopDevEnvironmentSession([/* ... */]);
$promise = $client->stopDevEnvironmentSessionAsync([/* ... */]);

Stops a session for a specified Dev Environment.

Parameter Syntax

$result = $client->stopDevEnvironmentSession([
    'id' => '<string>', // REQUIRED
    'projectName' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.

projectName
Required: Yes
Type: string

The name of the project in the space.

sessionId
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'id' => '<string>',
    'projectName' => '<string>',
    'sessionId' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

projectName
Required: Yes
Type: string

The name of the project in the space.

sessionId
Required: Yes
Type: string

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

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

UpdateDevEnvironment 

$result = $client->updateDevEnvironment([/* ... */]);
$promise = $client->updateDevEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateDevEnvironment([
    'alias' => '<string>',
    'clientToken' => '<string>',
    'id' => '<string>', // REQUIRED
    'ides' => [
        [
            'name' => '<string>',
            'runtime' => '<string>',
        ],
        // ...
    ],
    'inactivityTimeoutMinutes' => <integer>,
    'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge',
    'projectName' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
alias
Type: string

The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

clientToken
Type: 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.

id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

ides
Type: Array of IdeConfiguration structures

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

inactivityTimeoutMinutes
Type: int

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.

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

instanceType
Type: string

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

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'alias' => '<string>',
    'clientToken' => '<string>',
    'id' => '<string>',
    'ides' => [
        [
            'name' => '<string>',
            'runtime' => '<string>',
        ],
        // ...
    ],
    'inactivityTimeoutMinutes' => <integer>,
    'instanceType' => 'dev.standard1.small|dev.standard1.medium|dev.standard1.large|dev.standard1.xlarge',
    'projectName' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
alias
Type: string

The user-specified alias for the Dev Environment.

clientToken
Type: 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.

id
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

ides
Type: Array of IdeConfiguration structures

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

inactivityTimeoutMinutes
Type: int

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

instanceType
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

UpdateProject 

$result = $client->updateProject([/* ... */]);
$promise = $client->updateProjectAsync([/* ... */]);

Changes one or more values for a project.

Parameter Syntax

$result = $client->updateProject([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'spaceName' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the project.

name
Required: Yes
Type: string

The name of the project.

spaceName
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'displayName' => '<string>',
    'name' => '<string>',
    'spaceName' => '<string>',
]

Result Details

Members
description
Type: string

The description of the project.

displayName
Type: string

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

name
Type: string

The name of the project.

spaceName
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

UpdateSpace 

$result = $client->updateSpace([/* ... */]);
$promise = $client->updateSpaceAsync([/* ... */]);

Changes one or more values for a space.

Parameter Syntax

$result = $client->updateSpace([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
Type: string

The description of the space.

name
Required: Yes
Type: string

The name of the space.

Result Syntax

[
    'description' => '<string>',
    'displayName' => '<string>',
    'name' => '<string>',
]

Result Details

Members
description
Type: string

The description of the space.

displayName
Type: string

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

name
Type: string

The name of the space.

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

VerifySession 

$result = $client->verifySession([/* ... */]);
$promise = $client->verifySessionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->verifySession([
]);

Parameter Details

Members

Result Syntax

[
    'identity' => '<string>',
]

Result Details

Members
identity
Type: string

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

Errors

ThrottlingException:

The request was denied due to request throttling.

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.

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.

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.

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.

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.

Shapes

AccessDeniedException

Description

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.

Members
message
Required: Yes
Type: string

AccessTokenSummary

Description

Information about a specified personal access token (PAT).

Members
expiresTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

id
Required: Yes
Type: string

The system-generated ID of the personal access token.

name
Required: Yes
Type: string

The friendly name of the personal access token.

ConflictException

Description

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.

Members
message
Required: Yes
Type: string

DevEnvironmentAccessDetails

Description

Information about connection details for a Dev Environment.

Members
streamUrl
Required: Yes
Type: string

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

tokenValue
Required: Yes
Type: string

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

DevEnvironmentRepositorySummary

Description

Information about the source repsitory for a Dev Environment.

Members
branchName
Type: string

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

repositoryName
Required: Yes
Type: string

The name of the source repository.

DevEnvironmentSessionConfiguration

Description

Information about the configuration of a Dev Environment session.

Members
executeCommandSessionConfiguration
Type: ExecuteCommandSessionConfiguration structure

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

sessionType
Required: Yes
Type: string

The type of the session.

DevEnvironmentSessionSummary

Description

Information about active sessions for a Dev Environment.

Members
devEnvironmentId
Required: Yes
Type: string

The system-generated unique ID of the Dev Environment.

id
Required: Yes
Type: string

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

projectName
Required: Yes
Type: string

The name of the project in the space.

spaceName
Required: Yes
Type: string

The name of the space.

startedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the session started, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

DevEnvironmentSummary

Description

Information about a Dev Environment.

Members
alias
Type: string

The user-specified alias for the Dev Environment.

creatorId
Required: Yes
Type: string

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

id
Required: Yes
Type: string

The system-generated unique ID for the Dev Environment.

ides
Type: Array of Ide structures

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

inactivityTimeoutMinutes
Required: Yes
Type: int

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

instanceType
Required: Yes
Type: string

The Amazon EC2 instace type used for the Dev Environment.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

persistentStorage
Required: Yes
Type: PersistentStorage structure

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

projectName
Type: string

The name of the project in the space.

repositories
Required: Yes
Type: Array of DevEnvironmentRepositorySummary structures

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

spaceName
Type: string

The name of the space.

status
Required: Yes
Type: string

The status of the Dev Environment.

statusReason
Type: string

The reason for the status.

vpcConnectionName
Type: string

The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

EmailAddress

Description

Information about an email address.

Members
email
Type: string

The email address.

verified
Type: boolean

Whether the email address has been verified.

EventLogEntry

Description

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

Members
errorCode
Type: string

The code of the error, if any.

eventCategory
Required: Yes
Type: string

The category for the event.

eventName
Required: Yes
Type: string

The name of the event.

eventSource
Required: Yes
Type: string

The source of the event.

eventTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

eventType
Required: Yes
Type: string

The type of the event.

id
Required: Yes
Type: string

The system-generated unique ID of the event.

operationType
Required: Yes
Type: string

The type of the event.

projectInformation
Type: ProjectInformation structure

Information about the project where the event occurred.

requestId
Type: string

The system-generated unique ID of the request.

requestPayload
Type: EventPayload structure

Information about the payload of the request.

responsePayload
Type: EventPayload structure

Information about the payload of the response, if any.

sourceIpAddress
Type: string

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

userAgent
Type: string

The user agent whose actions are recorded in the event.

userIdentity
Required: Yes
Type: UserIdentity structure

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

EventPayload

Description

Information about the payload of an event recording Amazon CodeCatalyst activity.

Members
contentType
Type: string

The type of content in the event payload.

data
Type: string

The data included in the event payload.

ExecuteCommandSessionConfiguration

Description

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

Members
arguments
Type: Array of strings

An array of arguments containing arguments and members.

command
Required: Yes
Type: string

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

Filter

Description

Information about a filter used to limit results of a query.

Members
comparisonOperator
Type: string

The operator used to compare the fields.

key
Required: Yes
Type: string

A key that can be used to sort results.

values
Required: Yes
Type: Array of strings

The values of the key.

Ide

Description

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

Members
name
Type: string

The name of the IDE.

runtime
Type: string

A link to the IDE runtime image.

IdeConfiguration

Description

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

Members
name
Type: string

The name of the IDE. Valid values include Cloud9, IntelliJ, PyCharm, GoLand, and VSCode.

runtime
Type: string

A link to the IDE runtime image.

This parameter is not required for VSCode.

ListSourceRepositoriesItem

Description

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

Members
createdTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

description
Type: string

The description of the repository, if any.

id
Required: Yes
Type: string

The system-generated unique ID of the source repository.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

name
Required: Yes
Type: string

The name of the source repository.

ListSourceRepositoryBranchesItem

Description

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

Members
headCommitId
Type: string

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

lastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

name
Type: string

The name of the branch.

ref
Type: string

The Git reference name of the branch.

PersistentStorage

Description

Information about the persistent storage for a Dev Environment.

Members
sizeInGiB
Required: Yes
Type: int

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

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

PersistentStorageConfiguration

Description

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

Members
sizeInGiB
Required: Yes
Type: int

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

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

ProjectInformation

Description

Information about a project in a space.

Members
name
Type: string

The name of the project in the space.

projectId
Type: string

The system-generated unique ID of the project.

ProjectListFilter

Description

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

Members
comparisonOperator
Type: string

The operator used to compare the fields.

key
Required: Yes
Type: string

A key that can be used to sort results.

values
Required: Yes
Type: Array of strings

The values of the key.

ProjectSummary

Description

Information about a project.

Members
description
Type: string

The description of the project.

displayName
Type: string

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

name
Required: Yes
Type: string

The name of the project in the space.

RepositoryInput

Description

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

Members
branchName
Type: string

The name of the branch in a source repository.

repositoryName
Required: Yes
Type: string

The name of the source repository.

ResourceNotFoundException

Description

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.

Members
message
Required: Yes
Type: string

ServiceQuotaExceededException

Description

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.

Members
message
Required: Yes
Type: string

SpaceSummary

Description

Information about an space.

Members
description
Type: string

The description of the space.

displayName
Type: string

The friendly name of the space displayed to users.

name
Required: Yes
Type: string

The name of the space.

regionName
Required: Yes
Type: string

The Amazon Web Services Region where the space exists.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

UserIdentity

Description

Information about a user whose activity is recorded in an event for a space.

Members
awsAccountId
Type: string

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

principalId
Required: Yes
Type: string

The ID of the Amazon CodeCatalyst service principal.

userName
Type: string

The display name of the user in Amazon CodeCatalyst.

userType
Required: Yes
Type: string

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

ValidationException

Description

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.

Members
message
Required: Yes
Type: string

WorkflowDefinition

Description

Information about a workflow definition file.

Members
path
Required: Yes
Type: string

The path to the workflow definition file stored in the source repository for the project, including the file name.

WorkflowDefinitionSummary

Description

Information about a workflow definition.

Members
path
Required: Yes
Type: string

The path to the workflow definition file stored in the source repository for the project, including the file name.

WorkflowRunSortCriteria

Description

Information used to sort workflow runs in the returned list.

Members

WorkflowRunStatusReason

Description

Information about the status of a workflow run.

Members

WorkflowRunSummary

Description

Information about a workflow run.

Members
endTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

id
Required: Yes
Type: string

The system-generated unique ID of the workflow run.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

startTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

status
Required: Yes
Type: string

The status of the workflow run.

statusReasons
Type: Array of WorkflowRunStatusReason structures

The reasons for the workflow run status.

workflowId
Required: Yes
Type: string

The system-generated unique ID of the workflow.

workflowName
Required: Yes
Type: string

The name of the workflow.

WorkflowSortCriteria

Description

Information used to sort workflows in the returned list.

Members

WorkflowSummary

Description

Information about a workflow.

Members
createdTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

definition
Required: Yes
Type: WorkflowDefinitionSummary structure

Information about the workflow definition file.

id
Required: Yes
Type: string

The system-generated unique ID of a workflow.

lastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

name
Required: Yes
Type: string

The name of the workflow.

runMode
Required: Yes
Type: string

The run mode of the workflow.

sourceBranchName
Required: Yes
Type: string

The name of the branch of the source repository where the workflow definition file is stored.

sourceRepositoryName
Required: Yes
Type: string

The name of the source repository where the workflow definition file is stored.

status
Required: Yes
Type: string

The status of the workflow.