AWS CodeStar connections 2019-12-01
- Client: Aws\CodeStarconnections\CodeStarconnectionsClient
- Service ID: codestar-connections
- Version: 2019-12-01
This page describes the parameters and results for the operations of the AWS CodeStar connections (2019-12-01), and shows how to use the Aws\CodeStarconnections\CodeStarconnectionsClient object to call the described operations. This documentation is specific to the 2019-12-01 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 */)
.
- CreateConnection ( array $params = [] )
- 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.
- CreateHost ( array $params = [] )
- Creates a resource that represents the infrastructure where a third-party provider is installed.
- CreateRepositoryLink ( array $params = [] )
- Creates a link to a specified external Git repository.
- CreateSyncConfiguration ( array $params = [] )
- Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.
- DeleteConnection ( array $params = [] )
- The connection to be deleted.
- DeleteHost ( array $params = [] )
- The host to be deleted.
- DeleteRepositoryLink ( array $params = [] )
- Deletes the association between your connection and a specified external Git repository.
- DeleteSyncConfiguration ( array $params = [] )
- Deletes the sync configuration for a specified repository and connection.
- GetConnection ( array $params = [] )
- Returns the connection ARN and details such as status, owner, and provider type.
- GetHost ( array $params = [] )
- Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
- GetRepositoryLink ( array $params = [] )
- Returns details about a repository link.
- GetRepositorySyncStatus ( array $params = [] )
- Returns details about the sync status for a repository.
- GetResourceSyncStatus ( array $params = [] )
- Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
- GetSyncBlockerSummary ( array $params = [] )
- Returns a list of the most recent sync blockers.
- GetSyncConfiguration ( array $params = [] )
- Returns details about a sync configuration, including the sync type and resource name.
- ListConnections ( array $params = [] )
- Lists the connections associated with your account.
- ListHosts ( array $params = [] )
- Lists the hosts associated with your account.
- ListRepositoryLinks ( array $params = [] )
- Lists the repository links created for connections in your account.
- ListRepositorySyncDefinitions ( array $params = [] )
- Lists the repository sync definitions for repository links in your account.
- ListSyncConfigurations ( array $params = [] )
- Returns a list of sync configurations for a specified repository.
- ListTagsForResource ( array $params = [] )
- Gets the set of key-value pairs (metadata) that are used to manage the resource.
- TagResource ( array $params = [] )
- Adds to or modifies the tags of the given resource.
- UntagResource ( array $params = [] )
- Removes tags from an Amazon Web Services resource.
- UpdateHost ( array $params = [] )
- Updates a specified host with the provided configurations.
- UpdateRepositoryLink ( array $params = [] )
- Updates the association between your connection and a specified external Git repository.
- UpdateSyncBlocker ( array $params = [] )
- Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
- UpdateSyncConfiguration ( array $params = [] )
- Updates the sync configuration for your connection and a specified external Git repository.
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:
Operations
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
Members
- ConnectionName
-
- Required: Yes
- Type: string
The name of the connection to be created.
- HostArn
-
- Type: string
The Amazon Resource Name (ARN) of the host associated with the connection to be created.
- ProviderType
-
- Type: string
The name of the external provider where your third-party code repository is configured.
- Tags
-
- Type: Array of Tag structures
The key-value pair to use when tagging the resource.
Result Syntax
[ 'ConnectionArn' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- ConnectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when the connection is shared between Amazon Web Services services.
The ARN is never reused if the connection is deleted.
- Tags
-
- Type: Array of Tag structures
Specifies the tags applied to the resource.
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.
A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.
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
Members
- Name
-
- Required: Yes
- Type: string
The name of the host to be created.
- ProviderEndpoint
-
- Required: Yes
- Type: string
The endpoint of the infrastructure to be represented by the host after it is created.
- ProviderType
-
- Required: Yes
- Type: string
The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
- Tags
-
- Type: Array of Tag structures
Tags for the host to be created.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
Result Syntax
[ 'HostArn' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- HostArn
-
- Type: string
The Amazon Resource Name (ARN) of the host to be created.
- Tags
-
- Type: Array of Tag structures
Tags for the created host.
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
Members
- ConnectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection to be associated with the repository link.
- EncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) encryption key for the repository to be associated with the repository link.
- OwnerId
-
- Required: Yes
- Type: string
The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
- RepositoryName
-
- Required: Yes
- Type: string
The name of the repository to be associated with the repository link.
- Tags
-
- Type: Array of Tag structures
The tags for the repository to be associated with the repository link.
Result Syntax
[ 'RepositoryLinkInfo' => [ 'ConnectionArn' => '<string>', 'EncryptionKeyArn' => '<string>', 'OwnerId' => '<string>', 'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged', 'RepositoryLinkArn' => '<string>', 'RepositoryLinkId' => '<string>', 'RepositoryName' => '<string>', ], ]
Result Details
Members
- RepositoryLinkInfo
-
- Required: Yes
- Type: RepositoryLinkInfo structure
The returned information about the created repository link.
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
Members
- Branch
-
- Required: Yes
- Type: string
The branch in the repository from which changes will be synced.
- ConfigFile
-
- Required: Yes
- Type: string
The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.
- PublishDeploymentStatus
-
- Type: string
Whether to enable or disable publishing of deployment status to source providers.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.
- RoleArn
-
- Required: Yes
- Type: string
The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.
- SyncType
-
- Required: Yes
- Type: string
The type of sync configuration.
- TriggerResourceUpdateOn
-
- Type: string
When to trigger Git sync to begin the stack update.
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
Members
- SyncConfiguration
-
- Required: Yes
- Type: SyncConfiguration structure
The created sync configuration for the connection. A sync configuration allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.
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
Members
- ConnectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection to be deleted.
The ARN is never reused if the connection is deleted.
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.
A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.
Parameter Syntax
$result = $client->deleteHost([ 'HostArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HostArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the host to be deleted.
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
Members
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link to be deleted.
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
Members
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource associated with the sync configuration to be deleted.
- SyncType
-
- Required: Yes
- Type: string
The type of sync configuration to be deleted.
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
Members
- ConnectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of a connection.
Result Syntax
[ 'Connection' => [ 'ConnectionArn' => '<string>', 'ConnectionName' => '<string>', 'ConnectionStatus' => 'PENDING|AVAILABLE|ERROR', 'HostArn' => '<string>', 'OwnerAccountId' => '<string>', 'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged', ], ]
Result Details
Members
- Connection
-
- Type: Connection structure
The connection details, such as status, owner, and provider type.
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
Members
- HostArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the requested host.
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
Members
- Name
-
- Type: string
The name of the requested host.
- ProviderEndpoint
-
- Type: string
The endpoint of the infrastructure represented by the requested host.
- ProviderType
-
- Type: string
The provider type of the requested host, such as GitHub Enterprise Server.
- Status
-
- Type: string
The status of the requested host.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The VPC configuration of the requested host.
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
Members
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link to get.
Result Syntax
[ 'RepositoryLinkInfo' => [ 'ConnectionArn' => '<string>', 'EncryptionKeyArn' => '<string>', 'OwnerId' => '<string>', 'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged', 'RepositoryLinkArn' => '<string>', 'RepositoryLinkId' => '<string>', 'RepositoryName' => '<string>', ], ]
Result Details
Members
- RepositoryLinkInfo
-
- Required: Yes
- Type: RepositoryLinkInfo structure
The information returned for a specified repository link.
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
Members
- Branch
-
- Required: Yes
- Type: string
The branch of the repository link for the requested repository sync status.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The repository link ID for the requested repository sync status.
- SyncType
-
- Required: Yes
- Type: string
The sync type of the requested sync status.
Result Syntax
[ 'LatestSync' => [ 'Events' => [ [ 'Event' => '<string>', 'ExternalId' => '<string>', 'Time' => <DateTime>, 'Type' => '<string>', ], // ... ], 'StartedAt' => <DateTime>, 'Status' => 'FAILED|INITIATED|IN_PROGRESS|SUCCEEDED|QUEUED', ], ]
Result Details
Members
- LatestSync
-
- Required: Yes
- Type: RepositorySyncAttempt structure
The status of the latest sync returned for a specified repository and branch.
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
Members
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource for the sync status with the Git repository.
- SyncType
-
- Required: Yes
- Type: string
The sync type for the sync status with the Git repository.
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
Members
- DesiredState
-
- Type: Revision structure
The desired state of the Amazon Web Services resource for the sync status with the Git repository.
- LatestSuccessfulSync
-
- Type: ResourceSyncAttempt structure
The latest successful sync for the sync status with the Git repository.
- LatestSync
-
- Required: Yes
- Type: ResourceSyncAttempt structure
The latest sync for the sync status with the Git repository, whether successful or not.
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
Members
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.
- SyncType
-
- Required: Yes
- Type: string
The sync type for the sync blocker summary.
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
Members
- SyncBlockerSummary
-
- Required: Yes
- Type: SyncBlockerSummary structure
The list of sync blockers for a specified resource.
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
Members
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.
- SyncType
-
- Required: Yes
- Type: string
The sync type for the sync configuration for which you want to retrieve information.
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
Members
- SyncConfiguration
-
- Required: Yes
- Type: SyncConfiguration structure
The details about the sync configuration for which you want to retrieve information.
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
Members
- HostArnFilter
-
- Type: string
Filters the list of connections to those associated with a specified host.
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
nextToken
value. - NextToken
-
- Type: string
The token that was returned from the previous
ListConnections
call, which can be used to return the next set of connections in the list. - ProviderTypeFilter
-
- Type: string
Filters the list of connections to those associated with a specified provider, such as Bitbucket.
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
Members
- Connections
-
- Type: Array of Connection structures
A list of connections and the details for each connection, such as status, owner, and provider type.
- NextToken
-
- Type: string
A token that can be used in the next
ListConnections
call. To view all items in the list, continue to call this operation with each subsequent token until no morenextToken
values are returned.
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
Members
- MaxResults
-
- Type: int
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
nextToken
value. - NextToken
-
- Type: string
The token that was returned from the previous
ListHosts
call, which can be used to return the next set of hosts in the list.
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
Members
- Hosts
-
- Type: Array of Host structures
A list of hosts and the details for each host, such as status, endpoint, and provider type.
- NextToken
-
- Type: string
A token that can be used in the next
ListHosts
call. To view all items in the list, continue to call this operation with each subsequent token until no morenextToken
values are returned.
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
Members
- MaxResults
-
- Type: int
A non-zero, non-negative integer used to limit the number of returned results.
- NextToken
-
- Type: string
An enumeration token that, when provided in a request, returns the next batch of the results.
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
Members
- NextToken
-
- Type: string
An enumeration token that allows the operation to batch the results of the operation.
- RepositoryLinks
-
- Required: Yes
- Type: Array of RepositoryLinkInfo structures
Lists the repository links called by the list repository links operation.
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
Members
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link for the sync definition for which you want to retrieve information.
- SyncType
-
- Required: Yes
- Type: string
The sync type of the repository link for the the sync definition for which you want to retrieve information.
Result Syntax
[ 'NextToken' => '<string>', 'RepositorySyncDefinitions' => [ [ 'Branch' => '<string>', 'Directory' => '<string>', 'Parent' => '<string>', 'Target' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
An enumeration token that, when provided in a request, returns the next batch of the results.
- RepositorySyncDefinitions
-
- Required: Yes
- Type: Array of RepositorySyncDefinition structures
The list of repository sync definitions returned by the request. A
RepositorySyncDefinition
is a mapping from a repository branch to all the Amazon Web Services resources that are being synced from that branch.
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
Members
- MaxResults
-
- Type: int
A non-zero, non-negative integer used to limit the number of returned results.
- NextToken
-
- Type: string
An enumeration token that allows the operation to batch the results of the operation.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link for the requested list of sync configurations.
- SyncType
-
- Required: Yes
- Type: string
The sync type for the requested list of sync configurations.
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
Members
- NextToken
-
- Type: string
An enumeration token that allows the operation to batch the next results of the operation.
- SyncConfigurations
-
- Required: Yes
- Type: Array of SyncConfiguration structures
The list of repository sync definitions returned by the request.
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
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A list of tag key and value pairs associated with the specified resource.
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
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags you want to modify or add to the resource.
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
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to remove tags from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The list of keys for the tags to be removed from the resource.
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
Members
- HostArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the host to be updated.
- ProviderEndpoint
-
- Type: string
The URL or endpoint of the host to be updated.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The VPC configuration of the host to be updated. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.
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
Members
- ConnectionArn
-
- Type: string
The Amazon Resource Name (ARN) of the connection for the repository link to be updated. The updated connection ARN must have the same providerType (such as GitHub) as the original connection ARN for the repo link.
- EncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the encryption key for the repository link to be updated.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link to be updated.
Result Syntax
[ 'RepositoryLinkInfo' => [ 'ConnectionArn' => '<string>', 'EncryptionKeyArn' => '<string>', 'OwnerId' => '<string>', 'ProviderType' => 'Bitbucket|GitHub|GitHubEnterpriseServer|GitLab|GitLabSelfManaged', 'RepositoryLinkArn' => '<string>', 'RepositoryLinkId' => '<string>', 'RepositoryName' => '<string>', ], ]
Result Details
Members
- RepositoryLinkInfo
-
- Required: Yes
- Type: RepositoryLinkInfo structure
Information about the repository link to be updated.
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
Members
- Id
-
- Required: Yes
- Type: string
The ID of the sync blocker to be updated.
- ResolvedReason
-
- Required: Yes
- Type: string
The reason for resolving the sync blocker.
- ResourceName
-
- Required: Yes
- Type: string
The name of the resource for the sync blocker to be updated.
- SyncType
-
- Required: Yes
- Type: string
The sync type of the sync blocker to be updated.
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
Members
- ParentResourceName
-
- Type: string
The parent resource name for the sync blocker.
- ResourceName
-
- Required: Yes
- Type: string
The resource name for the sync blocker.
- SyncBlocker
-
- Required: Yes
- Type: SyncBlocker structure
Information about the sync blocker to be updated.
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
Members
- Branch
-
- Type: string
The branch for the sync configuration to be updated.
- ConfigFile
-
- Type: string
The configuration file for the sync configuration to be updated.
- PublishDeploymentStatus
-
- Type: string
Whether to enable or disable publishing of deployment status to source providers.
- RepositoryLinkId
-
- Type: string
The ID of the repository link for the sync configuration to be updated.
- ResourceName
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource for the sync configuration to be updated.
- RoleArn
-
- Type: string
The ARN of the IAM role for the sync configuration to be updated.
- SyncType
-
- Required: Yes
- Type: string
The sync type for the sync configuration to be updated.
- TriggerResourceUpdateOn
-
- Type: string
When to trigger Git sync to begin the stack update.
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
Members
- SyncConfiguration
-
- Required: Yes
- Type: SyncConfiguration structure
The information returned for the sync configuration to be updated.
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.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- Message
-
- Type: string
ConcurrentModificationException
Description
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.
Members
- Message
-
- Type: string
ConditionalCheckFailedException
Description
The conditional check failed. Try again later.
Members
- Message
-
- Type: string
ConflictException
Description
Two conflicting operations have been made on the same resource.
Members
- Message
-
- Type: string
Connection
Description
A resource that is used to connect third-party source providers with services like CodePipeline.
Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.
Members
- ConnectionArn
-
- Type: string
The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between Amazon Web Services.
The ARN is never reused if the connection is deleted.
- ConnectionName
-
- Type: string
The name of the connection. Connection names must be unique in an Amazon Web Services account.
- ConnectionStatus
-
- Type: string
The current status of the connection.
- HostArn
-
- Type: string
The Amazon Resource Name (ARN) of the host associated with the connection.
- OwnerAccountId
-
- Type: string
The identifier of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
- ProviderType
-
- Type: string
The name of the external provider where your third-party code repository is configured.
Host
Description
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.
A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.
Members
- HostArn
-
- Type: string
The Amazon Resource Name (ARN) of the host.
- Name
-
- Type: string
The name of the host.
- ProviderEndpoint
-
- Type: string
The endpoint of the infrastructure where your provider type is installed.
- ProviderType
-
- Type: string
The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.
- Status
-
- Type: string
The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.
- StatusMessage
-
- Type: string
The status description for the host.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The VPC configuration provisioned for the host.
InternalServerException
Description
Received an internal server exception. Try again later.
Members
- Message
-
- Type: string
InvalidInputException
Description
The input is not valid. Verify that the action is typed correctly.
Members
- Message
-
- Type: string
LimitExceededException
Description
Exceeded the maximum limit for connections.
Members
- Message
-
- Type: string
RepositoryLinkInfo
Description
Information about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.
Members
- ConnectionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the connection associated with the repository link.
- EncryptionKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.
- OwnerId
-
- Required: Yes
- Type: string
The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
- ProviderType
-
- Required: Yes
- Type: string
The provider type for the connection, such as GitHub, associated with the repository link.
- RepositoryLinkArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the repository link.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link.
- RepositoryName
-
- Required: Yes
- Type: string
The name of the repository associated with the repository link.
RepositorySyncAttempt
Description
Information about a repository sync attempt for a repository with a sync configuration.
Members
- Events
-
- Required: Yes
- Type: Array of RepositorySyncEvent structures
The events associated with a specific sync attempt.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of a specific sync attempt.
- Status
-
- Required: Yes
- Type: string
The status of a specific sync attempt. The following are valid statuses:
-
INITIATED - A repository sync attempt has been created and will begin soon.
-
IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.
-
SUCCEEDED - The repository sync attempt has completed successfully.
-
FAILED - The repository sync attempt has failed.
-
QUEUED - The repository sync attempt didn't execute and was queued.
RepositorySyncDefinition
Description
The definition for a repository with a sync configuration.
Members
- Branch
-
- Required: Yes
- Type: string
The branch specified for a repository sync definition.
- Directory
-
- Required: Yes
- Type: string
The configuration file for a repository sync definition. This value comes from creating or updating the
config-file
field of async-configuration
. - Parent
-
- Required: Yes
- Type: string
The parent resource specified for a repository sync definition.
- Target
-
- Required: Yes
- Type: string
The target resource specified for a repository sync definition. In some cases, such as CFN_STACK_SYNC, the parent and target resource are the same.
RepositorySyncEvent
Description
Information about a repository sync event.
Members
- Event
-
- Required: Yes
- Type: string
A description of a repository sync event.
- ExternalId
-
- Type: string
The ID for a repository sync event.
- Time
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that a repository sync event occurred.
- Type
-
- Required: Yes
- Type: string
The event type for a repository sync event.
ResourceAlreadyExistsException
Description
Unable to create resource. Resource already exists.
Members
- Message
-
- Type: string
ResourceNotFoundException
Description
Resource not found. Verify the connection resource ARN and try again.
Members
- Message
-
- Type: string
ResourceSyncAttempt
Description
Information about a resource sync attempt.
Members
- Events
-
- Required: Yes
- Type: Array of ResourceSyncEvent structures
The events related to a resource sync attempt.
- InitialRevision
-
- Required: Yes
- Type: Revision structure
The current state of the resource as defined in the resource's
config-file
in the linked repository. - StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for a resource sync attempt.
- Status
-
- Required: Yes
- Type: string
The status for a resource sync attempt. The follow are valid statuses:
-
SYNC-INITIATED - A resource sync attempt has been created and will begin soon.
-
SYNCING - Syncing has started and work is being done to reconcile state.
-
SYNCED - Syncing has completed successfully.
-
SYNC_FAILED - A resource sync attempt has failed.
- Target
-
- Required: Yes
- Type: string
The name of the Amazon Web Services resource that is attempted to be synchronized.
- TargetRevision
-
- Required: Yes
- Type: Revision structure
The desired state of the resource as defined in the resource's
config-file
in the linked repository. Git sync attempts to update the resource to this state.
ResourceSyncEvent
Description
Information about a resource sync event for the resource associated with a sync configuration.
Members
- Event
-
- Required: Yes
- Type: string
The event for a resource sync event.
- ExternalId
-
- Type: string
The ID for a resource sync event.
- Time
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that a resource sync event occurred.
- Type
-
- Required: Yes
- Type: string
The type of resource sync event.
ResourceUnavailableException
Description
Resource not found. Verify the ARN for the host resource and try again.
Members
- Message
-
- Type: string
RetryLatestCommitFailedException
Description
Retrying the latest commit failed. Try again later.
Members
- Message
-
- Type: string
Revision
Description
Information about the revision for a specific sync event, such as the branch, owner ID, and name of the repository.
Members
- Branch
-
- Required: Yes
- Type: string
The branch name for a specific revision.
- Directory
-
- Required: Yes
- Type: string
The directory, if any, for a specific revision.
- OwnerId
-
- Required: Yes
- Type: string
The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
- ProviderType
-
- Required: Yes
- Type: string
The provider type for a revision, such as GitHub.
- RepositoryName
-
- Required: Yes
- Type: string
The repository name for a specific revision.
- Sha
-
- Required: Yes
- Type: string
The SHA, such as the commit ID, for a specific revision.
SyncBlocker
Description
Information about a blocker for a sync event.
Members
- Contexts
-
- Type: Array of SyncBlockerContext structures
The contexts for a specific sync blocker.
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time for a specific sync blocker.
- CreatedReason
-
- Required: Yes
- Type: string
The provided reason for a specific sync blocker.
- Id
-
- Required: Yes
- Type: string
The ID for a specific sync blocker.
- ResolvedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that a specific sync blocker was resolved.
- ResolvedReason
-
- Type: string
The resolved reason for a specific sync blocker.
- Status
-
- Required: Yes
- Type: string
The status for a specific sync blocker.
- Type
-
- Required: Yes
- Type: string
The sync blocker type.
SyncBlockerContext
Description
The context for a specific sync blocker.
Members
- Key
-
- Required: Yes
- Type: string
The key provided for a context key-value pair for a specific sync blocker.
- Value
-
- Required: Yes
- Type: string
The value provided for a context key-value pair for a specific sync blocker.
SyncBlockerDoesNotExistException
Description
Unable to continue. The sync blocker does not exist.
Members
- Message
-
- Type: string
SyncBlockerSummary
Description
A summary for sync blockers.
Members
- LatestBlockers
-
- Type: Array of SyncBlocker structures
The latest events for a sync blocker summary.
- ParentResourceName
-
- Type: string
The parent resource name for a sync blocker summary.
- ResourceName
-
- Required: Yes
- Type: string
The resource name for sync blocker summary.
SyncConfiguration
Description
Information, such as repository, branch, provider, and resource names for a specific sync configuration.
Members
- Branch
-
- Required: Yes
- Type: string
The branch associated with a specific sync configuration.
- ConfigFile
-
- Type: string
The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.
- OwnerId
-
- Required: Yes
- Type: string
The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
- ProviderType
-
- Required: Yes
- Type: string
The connection provider type associated with a specific sync configuration, such as GitHub.
- PublishDeploymentStatus
-
- Type: string
Whether to enable or disable publishing of deployment status to source providers.
- RepositoryLinkId
-
- Required: Yes
- Type: string
The ID of the repository link associated with a specific sync configuration.
- RepositoryName
-
- Required: Yes
- Type: string
The name of the repository associated with a specific sync configuration.
- ResourceName
-
- Required: Yes
- Type: string
The name of the connection resource associated with a specific sync configuration.
- RoleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
- SyncType
-
- Required: Yes
- Type: string
The type of sync for a specific sync configuration.
- TriggerResourceUpdateOn
-
- Type: string
When to trigger Git sync to begin the stack update.
SyncConfigurationStillExistsException
Description
Unable to continue. The sync blocker still exists.
Members
- Message
-
- Type: string
Tag
Description
A tag is a key-value pair that is used to manage the resource.
This tag is available for use by Amazon Web Services services that support tags.
Members
- Key
-
- Required: Yes
- Type: string
The tag's key.
- Value
-
- Required: Yes
- Type: string
The tag's value.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- Message
-
- Type: string
UnsupportedOperationException
Description
The operation is not supported. Check the connection status and try again.
Members
- Message
-
- Type: string
UnsupportedProviderTypeException
Description
The specified provider type is not supported for connections.
Members
- Message
-
- Type: string
UpdateOutOfSyncException
Description
The update is out of sync. Try syncing again.
Members
- Message
-
- Type: string
VpcConfiguration
Description
The VPC configuration provisioned for the host.
Members
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
- TlsCertificate
-
- Type: string
The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.
- VpcId
-
- Required: Yes
- Type: string
The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.