CreateConnection

$result = $client->createConnection([/* ... */]);
$promise = $client->createConnectionAsync([/* ... */]);

Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

Parameter Syntax

$result = $client->createConnection([
    'ConnectionName' => '<string>', // REQUIRED
    'HostArn' => '<string>',
    'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ConnectionArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

LimitExceededException:

Exceeded the maximum limit for connections.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException:

Resource not found. Verify the ARN for the host resource and try again.

CreateHost

$result = $client->createHost([/* ... */]);
$promise = $client->createHostAsync([/* ... */]);

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

Parameter Syntax

$result = $client->createHost([
    'Name' => '<string>', // REQUIRED
    'ProviderEndpoint' => '<string>', // REQUIRED
    'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'TlsCertificate' => '<string>',
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'HostArn' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

LimitExceededException:

Exceeded the maximum limit for connections.

CreateRepositoryLink

$result = $client->createRepositoryLink([/* ... */]);
$promise = $client->createRepositoryLinkAsync([/* ... */]);

Creates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

Parameter Syntax

$result = $client->createRepositoryLink([
    'ConnectionArn' => '<string>', // REQUIRED
    'EncryptionKeyArn' => '<string>',
    'OwnerId' => '<string>', // REQUIRED
    'RepositoryName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'RepositoryLinkInfo' => [
        'ConnectionArn' => '<string>',
        'EncryptionKeyArn' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'RepositoryLinkArn' => '<string>',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

LimitExceededException:

Exceeded the maximum limit for connections.

ResourceAlreadyExistsException:

Unable to create resource. Resource already exists.

ThrottlingException:

The request was denied due to request throttling.

CreateSyncConfiguration

$result = $client->createSyncConfiguration([/* ... */]);
$promise = $client->createSyncConfigurationAsync([/* ... */]);

Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.

Parameter Syntax

$result = $client->createSyncConfiguration([
    'Branch' => '<string>', // REQUIRED
    'ConfigFile' => '<string>', // REQUIRED
    'PublishDeploymentStatus' => 'ENABLED|DISABLED',
    'RepositoryLinkId' => '<string>', // REQUIRED
    'ResourceName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
    'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
]);

Parameter Details

Result Syntax

[
    'SyncConfiguration' => [
        'Branch' => '<string>',
        'ConfigFile' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'PublishDeploymentStatus' => 'ENABLED|DISABLED',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
        'ResourceName' => '<string>',
        'RoleArn' => '<string>',
        'SyncType' => 'CFN_STACK_SYNC',
        'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

LimitExceededException:

Exceeded the maximum limit for connections.

ResourceAlreadyExistsException:

Unable to create resource. Resource already exists.

ThrottlingException:

The request was denied due to request throttling.

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

The connection to be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

DeleteHost

$result = $client->deleteHost([/* ... */]);
$promise = $client->deleteHostAsync([/* ... */]);

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException:

Resource not found. Verify the ARN for the host resource and try again.

DeleteRepositoryLink

$result = $client->deleteRepositoryLink([/* ... */]);
$promise = $client->deleteRepositoryLinkAsync([/* ... */]);

Deletes the association between your connection and a specified external Git repository.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

SyncConfigurationStillExistsException:

Unable to continue. The sync blocker still exists.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

UnsupportedProviderTypeException:

The specified provider type is not supported for connections.

DeleteSyncConfiguration

$result = $client->deleteSyncConfiguration([/* ... */]);
$promise = $client->deleteSyncConfigurationAsync([/* ... */]);

Deletes the sync configuration for a specified repository and connection.

Parameter Syntax

$result = $client->deleteSyncConfiguration([
    'ResourceName' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

LimitExceededException:

Exceeded the maximum limit for connections.

ThrottlingException:

The request was denied due to request throttling.

GetConnection

$result = $client->getConnection([/* ... */]);
$promise = $client->getConnectionAsync([/* ... */]);

Returns the connection ARN and details such as status, owner, and provider type.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Connection' => [
        'ConnectionArn' => '<string>',
        'ConnectionName' => '<string>',
        'ConnectionStatus' => 'PENDING|AVAILABLE|ERROR',
        'HostArn' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException:

Resource not found. Verify the ARN for the host resource and try again.

GetHost

$result = $client->getHost([/* ... */]);
$promise = $client->getHostAsync([/* ... */]);

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Name' => '<string>',
    'ProviderEndpoint' => '<string>',
    'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
    'Status' => '<string>',
    'VpcConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
        'TlsCertificate' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException:

Resource not found. Verify the ARN for the host resource and try again.

GetRepositoryLink

$result = $client->getRepositoryLink([/* ... */]);
$promise = $client->getRepositoryLinkAsync([/* ... */]);

Returns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RepositoryLinkInfo' => [
        'ConnectionArn' => '<string>',
        'EncryptionKeyArn' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'RepositoryLinkArn' => '<string>',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

GetRepositorySyncStatus

$result = $client->getRepositorySyncStatus([/* ... */]);
$promise = $client->getRepositorySyncStatusAsync([/* ... */]);

Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.

Parameter Syntax

$result = $client->getRepositorySyncStatus([
    'Branch' => '<string>', // REQUIRED
    'RepositoryLinkId' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LatestSync' => [
        'Events' => [
            [
                'Event' => '<string>',
                'ExternalId' => '<string>',
                'Time' => <DateTime>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'StartedAt' => <DateTime>,
        'Status' => 'FAILED|INITIATED|IN_PROGRESS|SUCCEEDED|QUEUED',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

GetResourceSyncStatus

$result = $client->getResourceSyncStatus([/* ... */]);
$promise = $client->getResourceSyncStatusAsync([/* ... */]);

Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.

Parameter Syntax

$result = $client->getResourceSyncStatus([
    'ResourceName' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DesiredState' => [
        'Branch' => '<string>',
        'Directory' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'RepositoryName' => '<string>',
        'Sha' => '<string>',
    ],
    'LatestSuccessfulSync' => [
        'Events' => [
            [
                'Event' => '<string>',
                'ExternalId' => '<string>',
                'Time' => <DateTime>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'InitialRevision' => [
            'Branch' => '<string>',
            'Directory' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'RepositoryName' => '<string>',
            'Sha' => '<string>',
        ],
        'StartedAt' => <DateTime>,
        'Status' => 'FAILED|INITIATED|IN_PROGRESS|SUCCEEDED',
        'Target' => '<string>',
        'TargetRevision' => [
            'Branch' => '<string>',
            'Directory' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'RepositoryName' => '<string>',
            'Sha' => '<string>',
        ],
    ],
    'LatestSync' => [
        'Events' => [
            [
                'Event' => '<string>',
                'ExternalId' => '<string>',
                'Time' => <DateTime>,
                'Type' => '<string>',
            ],
            // ...
        ],
        'InitialRevision' => [
            'Branch' => '<string>',
            'Directory' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'RepositoryName' => '<string>',
            'Sha' => '<string>',
        ],
        'StartedAt' => <DateTime>,
        'Status' => 'FAILED|INITIATED|IN_PROGRESS|SUCCEEDED',
        'Target' => '<string>',
        'TargetRevision' => [
            'Branch' => '<string>',
            'Directory' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'RepositoryName' => '<string>',
            'Sha' => '<string>',
        ],
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

GetSyncBlockerSummary

$result = $client->getSyncBlockerSummary([/* ... */]);
$promise = $client->getSyncBlockerSummaryAsync([/* ... */]);

Returns a list of the most recent sync blockers.

Parameter Syntax

$result = $client->getSyncBlockerSummary([
    'ResourceName' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SyncBlockerSummary' => [
        'LatestBlockers' => [
            [
                'Contexts' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'CreatedAt' => <DateTime>,
                'CreatedReason' => '<string>',
                'Id' => '<string>',
                'ResolvedAt' => <DateTime>,
                'ResolvedReason' => '<string>',
                'Status' => 'ACTIVE|RESOLVED',
                'Type' => 'AUTOMATED',
            ],
            // ...
        ],
        'ParentResourceName' => '<string>',
        'ResourceName' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

GetSyncConfiguration

$result = $client->getSyncConfiguration([/* ... */]);
$promise = $client->getSyncConfigurationAsync([/* ... */]);

Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.

Parameter Syntax

$result = $client->getSyncConfiguration([
    'ResourceName' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SyncConfiguration' => [
        'Branch' => '<string>',
        'ConfigFile' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'PublishDeploymentStatus' => 'ENABLED|DISABLED',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
        'ResourceName' => '<string>',
        'RoleArn' => '<string>',
        'SyncType' => 'CFN_STACK_SYNC',
        'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

ListConnections

$result = $client->listConnections([/* ... */]);
$promise = $client->listConnectionsAsync([/* ... */]);

Lists the connections associated with your account.

Parameter Syntax

$result = $client->listConnections([
    'HostArnFilter' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProviderTypeFilter' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
]);

Parameter Details

Result Syntax

[
    'Connections' => [
        [
            'ConnectionArn' => '<string>',
            'ConnectionName' => '<string>',
            'ConnectionStatus' => 'PENDING|AVAILABLE|ERROR',
            'HostArn' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ListHosts

$result = $client->listHosts([/* ... */]);
$promise = $client->listHostsAsync([/* ... */]);

Lists the hosts associated with your account.

Parameter Syntax

$result = $client->listHosts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Hosts' => [
        [
            'HostArn' => '<string>',
            'Name' => '<string>',
            'ProviderEndpoint' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'Status' => '<string>',
            'StatusMessage' => '<string>',
            'VpcConfiguration' => [
                'SecurityGroupIds' => ['<string>', ...],
                'SubnetIds' => ['<string>', ...],
                'TlsCertificate' => '<string>',
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListRepositoryLinks

$result = $client->listRepositoryLinks([/* ... */]);
$promise = $client->listRepositoryLinksAsync([/* ... */]);

Lists the repository links created for connections in your account.

Parameter Syntax

$result = $client->listRepositoryLinks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RepositoryLinks' => [
        [
            'ConnectionArn' => '<string>',
            'EncryptionKeyArn' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'RepositoryLinkArn' => '<string>',
            'RepositoryLinkId' => '<string>',
            'RepositoryName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

ListRepositorySyncDefinitions

$result = $client->listRepositorySyncDefinitions([/* ... */]);
$promise = $client->listRepositorySyncDefinitionsAsync([/* ... */]);

Lists the repository sync definitions for repository links in your account.

Parameter Syntax

$result = $client->listRepositorySyncDefinitions([
    'RepositoryLinkId' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RepositorySyncDefinitions' => [
        [
            'Branch' => '<string>',
            'Directory' => '<string>',
            'Parent' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

ListSyncConfigurations

$result = $client->listSyncConfigurations([/* ... */]);
$promise = $client->listSyncConfigurationsAsync([/* ... */]);

Returns a list of sync configurations for a specified repository.

Parameter Syntax

$result = $client->listSyncConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RepositoryLinkId' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SyncConfigurations' => [
        [
            'Branch' => '<string>',
            'ConfigFile' => '<string>',
            'OwnerId' => '<string>',
            'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
            'PublishDeploymentStatus' => 'ENABLED|DISABLED',
            'RepositoryLinkId' => '<string>',
            'RepositoryName' => '<string>',
            'ResourceName' => '<string>',
            'RoleArn' => '<string>',
            'SyncType' => 'CFN_STACK_SYNC',
            'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

LimitExceededException:

Exceeded the maximum limit for connections.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from an Amazon Web Services resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

UpdateHost

$result = $client->updateHost([/* ... */]);
$promise = $client->updateHostAsync([/* ... */]);

Updates a specified host with the provided configurations.

Parameter Syntax

$result = $client->updateHost([
    'HostArn' => '<string>', // REQUIRED
    'ProviderEndpoint' => '<string>',
    'VpcConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'TlsCertificate' => '<string>',
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

Two conflicting operations have been made on the same resource.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ResourceUnavailableException:

Resource not found. Verify the ARN for the host resource and try again.

UnsupportedOperationException:

The operation is not supported. Check the connection status and try again.

UpdateRepositoryLink

$result = $client->updateRepositoryLink([/* ... */]);
$promise = $client->updateRepositoryLinkAsync([/* ... */]);

Updates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

Parameter Syntax

$result = $client->updateRepositoryLink([
    'ConnectionArn' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'RepositoryLinkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RepositoryLinkInfo' => [
        'ConnectionArn' => '<string>',
        'EncryptionKeyArn' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'RepositoryLinkArn' => '<string>',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConditionalCheckFailedException:

The conditional check failed. Try again later.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

UpdateOutOfSyncException:

The update is out of sync. Try syncing again.

UpdateSyncBlocker

$result = $client->updateSyncBlocker([/* ... */]);
$promise = $client->updateSyncBlockerAsync([/* ... */]);

Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.

Parameter Syntax

$result = $client->updateSyncBlocker([
    'Id' => '<string>', // REQUIRED
    'ResolvedReason' => '<string>', // REQUIRED
    'ResourceName' => '<string>', // REQUIRED
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ParentResourceName' => '<string>',
    'ResourceName' => '<string>',
    'SyncBlocker' => [
        'Contexts' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CreatedAt' => <DateTime>,
        'CreatedReason' => '<string>',
        'Id' => '<string>',
        'ResolvedAt' => <DateTime>,
        'ResolvedReason' => '<string>',
        'Status' => 'ACTIVE|RESOLVED',
        'Type' => 'AUTOMATED',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

RetryLatestCommitFailedException:

Retrying the latest commit failed. Try again later.

SyncBlockerDoesNotExistException:

Unable to continue. The sync blocker does not exist.

ThrottlingException:

The request was denied due to request throttling.

UpdateSyncConfiguration

$result = $client->updateSyncConfiguration([/* ... */]);
$promise = $client->updateSyncConfigurationAsync([/* ... */]);

Updates the sync configuration for your connection and a specified external Git repository.

Parameter Syntax

$result = $client->updateSyncConfiguration([
    'Branch' => '<string>',
    'ConfigFile' => '<string>',
    'PublishDeploymentStatus' => 'ENABLED|DISABLED',
    'RepositoryLinkId' => '<string>',
    'ResourceName' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
    'SyncType' => 'CFN_STACK_SYNC', // REQUIRED
    'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
]);

Parameter Details

Result Syntax

[
    'SyncConfiguration' => [
        'Branch' => '<string>',
        'ConfigFile' => '<string>',
        'OwnerId' => '<string>',
        'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged',
        'PublishDeploymentStatus' => 'ENABLED|DISABLED',
        'RepositoryLinkId' => '<string>',
        'RepositoryName' => '<string>',
        'ResourceName' => '<string>',
        'RoleArn' => '<string>',
        'SyncType' => 'CFN_STACK_SYNC',
        'TriggerResourceUpdateOn' => 'ANY_CHANGE|FILE_CHANGE',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ConcurrentModificationException:

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

InternalServerException:

Received an internal server exception. Try again later.

InvalidInputException:

The input is not valid. Verify that the action is typed correctly.

ResourceNotFoundException:

Resource not found. Verify the connection resource ARN and try again.

ThrottlingException:

The request was denied due to request throttling.

UpdateOutOfSyncException:

The update is out of sync. Try syncing again.