Module Smaws_Client_CodeConnections

CodeConnections client library built on EIO.

Types

type vpc_configuration = {
  1. tls_certificate : string option;
    (*

    The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

    *)
  2. security_group_ids : string list;
    (*

    The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    *)
  3. subnet_ids : string list;
    (*

    The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

    *)
  4. vpc_id : string;
    (*

    The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

    *)
}

The VPC configuration provisioned for the host.

type provider_type =
  1. | GITLAB_SELF_MANAGED
  2. | GITLAB
  3. | GITHUB_ENTERPRISE_SERVER
  4. | GITHUB
  5. | BITBUCKET
type sync_configuration_type =
  1. | CFN_STACK_SYNC
type publish_deployment_status =
  1. | DISABLED
  2. | ENABLED
type trigger_resource_update_on =
  1. | FILE_CHANGE
  2. | ANY_CHANGE
type sync_configuration = {
  1. trigger_resource_update_on : trigger_resource_update_on option;
    (*

    When to trigger Git sync to begin the stack update.

    *)
  2. publish_deployment_status : publish_deployment_status option;
    (*

    Whether to enable or disable publishing of deployment status to source providers.

    *)
  3. sync_type : sync_configuration_type;
    (*

    The type of sync for a specific sync configuration.

    *)
  4. role_arn : string;
    (*

    The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

    *)
  5. resource_name : string;
    (*

    The name of the connection resource associated with a specific sync configuration.

    *)
  6. repository_name : string;
    (*

    The name of the repository associated with a specific sync configuration.

    *)
  7. provider_type : provider_type;
    (*

    The connection provider type associated with a specific sync configuration, such as GitHub.

    *)
  8. owner_id : string;
    (*

    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

    *)
  9. config_file : string option;
    (*

    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.

    *)
  10. branch : string;
    (*

    The branch associated with a specific sync configuration.

    *)
}

Information, such as repository, branch, provider, and resource names for a specific sync configuration.

type update_sync_configuration_output = {
  1. sync_configuration : sync_configuration;
    (*

    The information returned for the sync configuration to be updated.

    *)
}
type update_sync_configuration_input = {
  1. trigger_resource_update_on : trigger_resource_update_on option;
    (*

    When to trigger Git sync to begin the stack update.

    *)
  2. publish_deployment_status : publish_deployment_status option;
    (*

    Whether to enable or disable publishing of deployment status to source providers.

    *)
  3. sync_type : sync_configuration_type;
    (*

    The sync type for the sync configuration to be updated.

    *)
  4. role_arn : string option;
    (*

    The ARN of the IAM role for the sync configuration to be updated.

    *)
  5. resource_name : string;
    (*

    The name of the Amazon Web Services resource for the sync configuration to be updated.

    *)
  6. config_file : string option;
    (*

    The configuration file for the sync configuration to be updated.

    *)
  7. branch : string option;
    (*

    The branch for the sync configuration to be updated.

    *)
}
type update_out_of_sync_exception = {
  1. message : string option;
}

The update is out of sync. Try syncing again.

type throttling_exception = {
  1. message : string option;
}

The request was denied due to request throttling.

type resource_not_found_exception = {
  1. message : string option;
}

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

type invalid_input_exception = {
  1. message : string option;
}

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

type internal_server_exception = {
  1. message : string option;
}

Received an internal server exception. Try again later.

type concurrent_modification_exception = {
  1. message : string option;
}

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.

type access_denied_exception = {
  1. message : string option;
}

You do not have sufficient access to perform this action.

type blocker_type =
  1. | AUTOMATED
type blocker_status =
  1. | RESOLVED
  2. | ACTIVE
type sync_blocker_context = {
  1. value : string;
    (*

    The value provided for a context key-value pair for a specific sync blocker.

    *)
  2. key : string;
    (*

    The key provided for a context key-value pair for a specific sync blocker.

    *)
}

The context for a specific sync blocker.

type sync_blocker = {
  1. resolved_at : float option;
    (*

    The time that a specific sync blocker was resolved.

    *)
  2. resolved_reason : string option;
    (*

    The resolved reason for a specific sync blocker.

    *)
  3. contexts : sync_blocker_context list option;
    (*

    The contexts for a specific sync blocker.

    *)
  4. created_at : float;
    (*

    The creation time for a specific sync blocker.

    *)
  5. created_reason : string;
    (*

    The provided reason for a specific sync blocker.

    *)
  6. status : blocker_status;
    (*

    The status for a specific sync blocker.

    *)
  7. type_ : blocker_type;
    (*

    The sync blocker type.

    *)
  8. id : string;
    (*

    The ID for a specific sync blocker.

    *)
}

Information about a blocker for a sync event.

type update_sync_blocker_output = {
  1. sync_blocker : sync_blocker;
    (*

    Information about the sync blocker to be updated.

    *)
  2. parent_resource_name : string option;
    (*

    The parent resource name for the sync blocker.

    *)
  3. resource_name : string;
    (*

    The resource name for the sync blocker.

    *)
}
type update_sync_blocker_input = {
  1. resolved_reason : string;
    (*

    The reason for resolving the sync blocker.

    *)
  2. resource_name : string;
    (*

    The name of the resource for the sync blocker to be updated.

    *)
  3. sync_type : sync_configuration_type;
    (*

    The sync type of the sync blocker to be updated.

    *)
  4. id : string;
    (*

    The ID of the sync blocker to be updated.

    *)
}
type sync_blocker_does_not_exist_exception = {
  1. message : string option;
}

Unable to continue. The sync blocker does not exist.

type retry_latest_commit_failed_exception = {
  1. message : string option;
}

Retrying the latest commit failed. Try again later.

Information about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.

type conditional_check_failed_exception = {
  1. message : string option;
}

The conditional check failed. Try again later.

type update_host_output = unit
type update_host_input = {
  1. vpc_configuration : vpc_configuration option;
    (*

    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.

    *)
  2. provider_endpoint : string option;
    (*

    The URL or endpoint of the host to be updated.

    *)
  3. host_arn : string;
    (*

    The Amazon Resource Name (ARN) of the host to be updated.

    *)
}
type unsupported_operation_exception = {
  1. message : string option;
}

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

type resource_unavailable_exception = {
  1. message : string option;
}

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

type conflict_exception = {
  1. message : string option;
}

Two conflicting operations have been made on the same resource.

type untag_resource_output = unit
type untag_resource_input = {
  1. tag_keys : string list;
    (*

    The list of keys for the tags to be removed from the resource.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource to remove tags from.

    *)
}
type unsupported_provider_type_exception = {
  1. message : string option;
}

The specified provider type is not supported for connections.

type tag_resource_output = unit
type tag = {
  1. value : string;
    (*

    The tag's value.

    *)
  2. key : string;
    (*

    The tag's key.

    *)
}

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.

type tag_resource_input = {
  1. tags : tag list;
    (*

    The tags you want to modify or add to the resource.

    *)
  2. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.

    *)
}
type limit_exceeded_exception = {
  1. message : string option;
}

Exceeded the maximum limit for connections.

type sync_configuration_still_exists_exception = {
  1. message : string option;
}

Unable to continue. The sync blocker still exists.

type sync_blocker_summary = {
  1. latest_blockers : sync_blocker list option;
    (*

    The latest events for a sync blocker summary.

    *)
  2. parent_resource_name : string option;
    (*

    The parent resource name for a sync blocker summary.

    *)
  3. resource_name : string;
    (*

    The resource name for sync blocker summary.

    *)
}

A summary for sync blockers.

type revision = {
  1. sha : string;
    (*

    The SHA, such as the commit ID, for a specific revision.

    *)
  2. provider_type : provider_type;
    (*

    The provider type for a revision, such as GitHub.

    *)
  3. repository_name : string;
    (*

    The repository name for a specific revision.

    *)
  4. owner_id : string;
    (*

    The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.

    *)
  5. directory : string;
    (*

    The directory, if any, for a specific revision.

    *)
  6. branch : string;
    (*

    The branch name for a specific revision.

    *)
}

Information about the revision for a specific sync event, such as the branch, owner ID, and name of the repository.

type resource_sync_status =
  1. | SUCCEEDED
  2. | IN_PROGRESS
  3. | INITIATED
  4. | FAILED
type resource_sync_event = {
  1. type_ : string;
    (*

    The type of resource sync event.

    *)
  2. time : float;
    (*

    The time that a resource sync event occurred.

    *)
  3. external_id : string option;
    (*

    The ID for a resource sync event.

    *)
  4. event : string;
    (*

    The event for a resource sync event.

    *)
}

Information about a resource sync event for the resource associated with a sync configuration.

type resource_sync_attempt = {
  1. target : string;
    (*

    The name of the Amazon Web Services resource that is attempted to be synchronized.

    *)
  2. target_revision : revision;
    (*

    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.

    *)
  3. status : resource_sync_status;
    (*

    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.
    *)
  4. started_at : float;
    (*

    The start time for a resource sync attempt.

    *)
  5. initial_revision : revision;
    (*

    The current state of the resource as defined in the resource's config-file in the linked repository.

    *)
  6. events : resource_sync_event list;
    (*

    The events related to a resource sync attempt.

    *)
}

Information about a resource sync attempt.

type resource_already_exists_exception = {
  1. message : string option;
}

Unable to create resource. Resource already exists.

type repository_sync_status =
  1. | QUEUED
  2. | SUCCEEDED
  3. | IN_PROGRESS
  4. | INITIATED
  5. | FAILED
type repository_sync_event = {
  1. type_ : string;
    (*

    The event type for a repository sync event.

    *)
  2. time : float;
    (*

    The time that a repository sync event occurred.

    *)
  3. external_id : string option;
    (*

    The ID for a repository sync event.

    *)
  4. event : string;
    (*

    A description of a repository sync event.

    *)
}

Information about a repository sync event.

type repository_sync_definition = {
  1. target : 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.

    *)
  2. parent : string;
    (*

    The parent resource specified for a repository sync definition.

    *)
  3. directory : string;
    (*

    The configuration file for a repository sync definition. This value comes from creating or updating the config-file field of a sync-configuration.

    *)
  4. branch : string;
    (*

    The branch specified for a repository sync definition.

    *)
}

The definition for a repository with a sync configuration.

type repository_sync_attempt = {
  1. events : repository_sync_event list;
    (*

    The events associated with a specific sync attempt.

    *)
  2. status : repository_sync_status;
    (*

    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.
    *)
  3. started_at : float;
    (*

    The start time of a specific sync attempt.

    *)
}

Information about a repository sync attempt for a repository with a sync configuration.

type list_tags_for_resource_output = {
  1. tags : tag list option;
    (*

    A list of tag key and value pairs associated with the specified resource.

    *)
}
type list_tags_for_resource_input = {
  1. resource_arn : string;
    (*

    The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

    *)
}
type list_sync_configurations_output = {
  1. next_token : string option;
    (*

    An enumeration token that allows the operation to batch the next results of the operation.

    *)
  2. sync_configurations : sync_configuration list;
    (*

    The list of repository sync definitions returned by the request.

    *)
}
type list_sync_configurations_input = {
  1. sync_type : sync_configuration_type;
    (*

    The sync type for the requested list of sync configurations.

    *)
  2. next_token : string option;
    (*

    An enumeration token that allows the operation to batch the results of the operation.

    *)
  3. max_results : int option;
    (*

    A non-zero, non-negative integer used to limit the number of returned results.

    *)
}
type list_repository_sync_definitions_output = {
  1. next_token : string option;
    (*

    An enumeration token that, when provided in a request, returns the next batch of the results.

    *)
  2. repository_sync_definitions : repository_sync_definition list;
    (*

    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.

    *)
}
type list_repository_sync_definitions_input = {
  1. sync_type : sync_configuration_type;
    (*

    The sync type of the repository link for the the sync definition for which you want to retrieve information.

    *)
}
type host = {
  1. status_message : string option;
    (*

    The status description for the host.

    *)
  2. status : string option;
    (*

    The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

    *)
  3. vpc_configuration : vpc_configuration option;
    (*

    The VPC configuration provisioned for the host.

    *)
  4. provider_endpoint : string option;
    (*

    The endpoint of the infrastructure where your provider type is installed.

    *)
  5. provider_type : provider_type option;
    (*

    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.

    *)
  6. host_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the host.

    *)
  7. name : string option;
    (*

    The name of the host.

    *)
}

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.

type list_hosts_output = {
  1. next_token : string option;
    (*

    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 more nextToken values are returned.

    *)
  2. hosts : host list option;
    (*

    A list of hosts and the details for each host, such as status, endpoint, and provider type.

    *)
}
type list_hosts_input = {
  1. next_token : string option;
    (*

    The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

    *)
  2. max_results : int option;
    (*

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    *)
}
type connection_status =
  1. | ERROR
  2. | AVAILABLE
  3. | PENDING
type connection = {
  1. host_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the host associated with the connection.

    *)
  2. connection_status : connection_status option;
    (*

    The current status of the connection.

    *)
  3. owner_account_id : string option;
    (*

    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.

    *)
  4. provider_type : provider_type option;
    (*

    The name of the external provider where your third-party code repository is configured.

    *)
  5. connection_arn : string option;
    (*

    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.

    *)
  6. connection_name : string option;
    (*

    The name of the connection. Connection names must be unique in an Amazon Web Services account.

    *)
}

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.

type list_connections_output = {
  1. next_token : string option;
    (*

    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 more nextToken values are returned.

    *)
  2. connections : connection list option;
    (*

    A list of connections and the details for each connection, such as status, owner, and provider type.

    *)
}
type list_connections_input = {
  1. next_token : string option;
    (*

    The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

    *)
  2. max_results : int option;
    (*

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    *)
  3. host_arn_filter : string option;
    (*

    Filters the list of connections to those associated with a specified host.

    *)
  4. provider_type_filter : provider_type option;
    (*

    Filters the list of connections to those associated with a specified provider, such as Bitbucket.

    *)
}
type get_sync_configuration_output = {
  1. sync_configuration : sync_configuration;
    (*

    The details about the sync configuration for which you want to retrieve information.

    *)
}
type get_sync_configuration_input = {
  1. resource_name : string;
    (*

    The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.

    *)
  2. sync_type : sync_configuration_type;
    (*

    The sync type for the sync configuration for which you want to retrieve information.

    *)
}
type get_sync_blocker_summary_output = {
  1. sync_blocker_summary : sync_blocker_summary;
    (*

    The list of sync blockers for a specified resource.

    *)
}
type get_sync_blocker_summary_input = {
  1. resource_name : string;
    (*

    The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.

    *)
  2. sync_type : sync_configuration_type;
    (*

    The sync type for the sync blocker summary.

    *)
}
type get_resource_sync_status_output = {
  1. latest_sync : resource_sync_attempt;
    (*

    The latest sync for the sync status with the Git repository, whether successful or not.

    *)
  2. latest_successful_sync : resource_sync_attempt option;
    (*

    The latest successful sync for the sync status with the Git repository.

    *)
  3. desired_state : revision option;
    (*

    The desired state of the Amazon Web Services resource for the sync status with the Git repository.

    *)
}
type get_resource_sync_status_input = {
  1. sync_type : sync_configuration_type;
    (*

    The sync type for the sync status with the Git repository.

    *)
  2. resource_name : string;
    (*

    The name of the Amazon Web Services resource for the sync status with the Git repository.

    *)
}
type get_repository_sync_status_output = {
  1. latest_sync : repository_sync_attempt;
    (*

    The status of the latest sync returned for a specified repository and branch.

    *)
}
type get_repository_sync_status_input = {
  1. sync_type : sync_configuration_type;
    (*

    The sync type of the requested sync status.

    *)
  2. branch : string;
    (*

    The branch of the repository link for the requested repository sync status.

    *)
}
type get_host_output = {
  1. vpc_configuration : vpc_configuration option;
    (*

    The VPC configuration of the requested host.

    *)
  2. provider_endpoint : string option;
    (*

    The endpoint of the infrastructure represented by the requested host.

    *)
  3. provider_type : provider_type option;
    (*

    The provider type of the requested host, such as GitHub Enterprise Server.

    *)
  4. status : string option;
    (*

    The status of the requested host.

    *)
  5. name : string option;
    (*

    The name of the requested host.

    *)
}
type get_host_input = {
  1. host_arn : string;
    (*

    The Amazon Resource Name (ARN) of the requested host.

    *)
}
type get_connection_output = {
  1. connection : connection option;
    (*

    The connection details, such as status, owner, and provider type.

    *)
}
type get_connection_input = {
  1. connection_arn : string;
    (*

    The Amazon Resource Name (ARN) of a connection.

    *)
}
type delete_sync_configuration_output = unit
type delete_sync_configuration_input = {
  1. resource_name : string;
    (*

    The name of the Amazon Web Services resource associated with the sync configuration to be deleted.

    *)
  2. sync_type : sync_configuration_type;
    (*

    The type of sync configuration to be deleted.

    *)
}
type delete_host_output = unit
type delete_host_input = {
  1. host_arn : string;
    (*

    The Amazon Resource Name (ARN) of the host to be deleted.

    *)
}
type delete_connection_output = unit
type delete_connection_input = {
  1. connection_arn : string;
    (*

    The Amazon Resource Name (ARN) of the connection to be deleted.

    The ARN is never reused if the connection is deleted.

    *)
}
type create_sync_configuration_output = {
  1. sync_configuration : sync_configuration;
    (*

    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.

    *)
}
type create_sync_configuration_input = {
  1. trigger_resource_update_on : trigger_resource_update_on option;
    (*

    When to trigger Git sync to begin the stack update.

    *)
  2. publish_deployment_status : publish_deployment_status option;
    (*

    Whether to enable or disable publishing of deployment status to source providers.

    *)
  3. sync_type : sync_configuration_type;
    (*

    The type of sync configuration.

    *)
  4. role_arn : 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.

    *)
  5. resource_name : 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.

    *)
  6. config_file : 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.

    *)
  7. branch : string;
    (*

    The branch in the repository from which changes will be synced.

    *)
}
type create_host_output = {
  1. tags : tag list option;
    (*

    Tags for the created host.

    *)
  2. host_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the host to be created.

    *)
}
type create_host_input = {
  1. tags : tag list option;
    (*

    Tags for the host to be created.

    *)
  2. vpc_configuration : vpc_configuration option;
    (*

    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.

    *)
  3. provider_endpoint : string;
    (*

    The endpoint of the infrastructure to be represented by the host after it is created.

    *)
  4. provider_type : provider_type;
    (*

    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.

    *)
  5. name : string;
    (*

    The name of the host to be created.

    *)
}
type create_connection_output = {
  1. tags : tag list option;
    (*

    Specifies the tags applied to the resource.

    *)
  2. connection_arn : 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.

    *)
}
type create_connection_input = {
  1. host_arn : string option;
    (*

    The Amazon Resource Name (ARN) of the host associated with the connection to be created.

    *)
  2. tags : tag list option;
    (*

    The key-value pair to use when tagging the resource.

    *)
  3. connection_name : string;
    (*

    The name of the connection to be created.

    *)
  4. provider_type : provider_type option;
    (*

    The name of the external provider where your third-party code repository is configured.

    *)
}

AWS CodeConnections This Amazon Web Services CodeConnections API Reference provides descriptions and usage examples of the operations and data types for the Amazon Web Services CodeConnections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect Amazon Web Services resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

You can work with hosts by calling:

You can work with tags in Amazon Web Services CodeConnections by calling the following:

For information about how to use Amazon Web Services CodeConnections, see the Developer Tools User Guide.

type base_document = Smaws_Lib.Json.t

Builders

val make_vpc_configuration : ?tls_certificate:string -> security_group_ids:string list -> subnet_ids:string list -> vpc_id:string -> unit -> vpc_configuration

Create a vpc_configuration type

val make_sync_configuration : ?trigger_resource_update_on:trigger_resource_update_on -> ?publish_deployment_status:publish_deployment_status -> ?config_file:string -> sync_type:sync_configuration_type -> role_arn:string -> resource_name:string -> repository_name:string -> repository_link_id:string -> provider_type:provider_type -> owner_id:string -> branch:string -> unit -> sync_configuration

Create a sync_configuration type

val make_update_sync_configuration_output : sync_configuration:sync_configuration -> unit -> update_sync_configuration_output
val make_update_sync_configuration_input : ?trigger_resource_update_on:trigger_resource_update_on -> ?publish_deployment_status:publish_deployment_status -> ?role_arn:string -> ?repository_link_id:string -> ?config_file:string -> ?branch:string -> sync_type:sync_configuration_type -> resource_name:string -> unit -> update_sync_configuration_input
val make_sync_blocker_context : value:string -> key:string -> unit -> sync_blocker_context

Create a sync_blocker_context type

val make_sync_blocker : ?resolved_at:float -> ?resolved_reason:string -> ?contexts:sync_blocker_context list -> created_at:float -> created_reason:string -> status:blocker_status -> type_:blocker_type -> id:string -> unit -> sync_blocker

Create a sync_blocker type

val make_update_sync_blocker_output : ?parent_resource_name:string -> sync_blocker:sync_blocker -> resource_name:string -> unit -> update_sync_blocker_output
val make_update_sync_blocker_input : resolved_reason:string -> resource_name:string -> sync_type:sync_configuration_type -> id:string -> unit -> update_sync_blocker_input

Create a repository_link_info type

val make_update_host_output : unit -> update_host_output

Create a update_host_output type

val make_update_host_input : ?vpc_configuration:vpc_configuration -> ?provider_endpoint:string -> host_arn:string -> unit -> update_host_input

Create a update_host_input type

val make_untag_resource_output : unit -> untag_resource_output

Create a untag_resource_output type

val make_untag_resource_input : tag_keys:string list -> resource_arn:string -> unit -> untag_resource_input

Create a untag_resource_input type

val make_tag_resource_output : unit -> tag_resource_output

Create a tag_resource_output type

val make_tag : value:string -> key:string -> unit -> tag

Create a tag type

val make_tag_resource_input : tags:tag list -> resource_arn:string -> unit -> tag_resource_input

Create a tag_resource_input type

val make_sync_blocker_summary : ?latest_blockers:sync_blocker list -> ?parent_resource_name:string -> resource_name:string -> unit -> sync_blocker_summary

Create a sync_blocker_summary type

val make_revision : sha:string -> provider_type:provider_type -> repository_name:string -> owner_id:string -> directory:string -> branch:string -> unit -> revision

Create a revision type

val make_resource_sync_event : ?external_id:string -> type_:string -> time:float -> event:string -> unit -> resource_sync_event

Create a resource_sync_event type

val make_resource_sync_attempt : target:string -> target_revision:revision -> status:resource_sync_status -> started_at:float -> initial_revision:revision -> events:resource_sync_event list -> unit -> resource_sync_attempt

Create a resource_sync_attempt type

val make_repository_sync_event : ?external_id:string -> type_:string -> time:float -> event:string -> unit -> repository_sync_event

Create a repository_sync_event type

val make_repository_sync_definition : target:string -> parent:string -> directory:string -> branch:string -> unit -> repository_sync_definition
val make_repository_sync_attempt : events:repository_sync_event list -> status:repository_sync_status -> started_at:float -> unit -> repository_sync_attempt
val make_list_tags_for_resource_output : ?tags:tag list -> unit -> list_tags_for_resource_output
val make_list_tags_for_resource_input : resource_arn:string -> unit -> list_tags_for_resource_input
val make_list_sync_configurations_output : ?next_token:string -> sync_configurations:sync_configuration list -> unit -> list_sync_configurations_output
val make_list_sync_configurations_input : ?next_token:string -> ?max_results:int -> sync_type:sync_configuration_type -> repository_link_id:string -> unit -> list_sync_configurations_input
val make_list_repository_sync_definitions_output : ?next_token:string -> repository_sync_definitions:repository_sync_definition list -> unit -> list_repository_sync_definitions_output
val make_list_repository_sync_definitions_input : sync_type:sync_configuration_type -> repository_link_id:string -> unit -> list_repository_sync_definitions_input
val make_host : ?status_message:string -> ?status:string -> ?vpc_configuration:vpc_configuration -> ?provider_endpoint:string -> ?provider_type:provider_type -> ?host_arn:string -> ?name:string -> unit -> host

Create a host type

val make_list_hosts_output : ?next_token:string -> ?hosts:host list -> unit -> list_hosts_output

Create a list_hosts_output type

val make_list_hosts_input : ?next_token:string -> ?max_results:int -> unit -> list_hosts_input

Create a list_hosts_input type

val make_connection : ?host_arn:string -> ?connection_status:connection_status -> ?owner_account_id:string -> ?provider_type:provider_type -> ?connection_arn:string -> ?connection_name:string -> unit -> connection

Create a connection type

val make_list_connections_output : ?next_token:string -> ?connections:connection list -> unit -> list_connections_output
val make_list_connections_input : ?next_token:string -> ?max_results:int -> ?host_arn_filter:string -> ?provider_type_filter:provider_type -> unit -> list_connections_input
val make_get_sync_configuration_output : sync_configuration:sync_configuration -> unit -> get_sync_configuration_output
val make_get_sync_configuration_input : resource_name:string -> sync_type:sync_configuration_type -> unit -> get_sync_configuration_input
val make_get_sync_blocker_summary_output : sync_blocker_summary:sync_blocker_summary -> unit -> get_sync_blocker_summary_output
val make_get_sync_blocker_summary_input : resource_name:string -> sync_type:sync_configuration_type -> unit -> get_sync_blocker_summary_input
val make_get_resource_sync_status_output : ?latest_successful_sync:resource_sync_attempt -> ?desired_state:revision -> latest_sync:resource_sync_attempt -> unit -> get_resource_sync_status_output
val make_get_resource_sync_status_input : sync_type:sync_configuration_type -> resource_name:string -> unit -> get_resource_sync_status_input
val make_get_repository_sync_status_output : latest_sync:repository_sync_attempt -> unit -> get_repository_sync_status_output
val make_get_repository_sync_status_input : sync_type:sync_configuration_type -> repository_link_id:string -> branch:string -> unit -> get_repository_sync_status_input
val make_get_host_output : ?vpc_configuration:vpc_configuration -> ?provider_endpoint:string -> ?provider_type:provider_type -> ?status:string -> ?name:string -> unit -> get_host_output

Create a get_host_output type

val make_get_host_input : host_arn:string -> unit -> get_host_input

Create a get_host_input type

val make_get_connection_output : ?connection:connection -> unit -> get_connection_output

Create a get_connection_output type

val make_get_connection_input : connection_arn:string -> unit -> get_connection_input

Create a get_connection_input type

val make_delete_sync_configuration_output : unit -> delete_sync_configuration_output
val make_delete_sync_configuration_input : resource_name:string -> sync_type:sync_configuration_type -> unit -> delete_sync_configuration_input
val make_delete_host_output : unit -> delete_host_output

Create a delete_host_output type

val make_delete_host_input : host_arn:string -> unit -> delete_host_input

Create a delete_host_input type

val make_delete_connection_output : unit -> delete_connection_output
val make_delete_connection_input : connection_arn:string -> unit -> delete_connection_input
val make_create_sync_configuration_output : sync_configuration:sync_configuration -> unit -> create_sync_configuration_output
val make_create_sync_configuration_input : ?trigger_resource_update_on:trigger_resource_update_on -> ?publish_deployment_status:publish_deployment_status -> sync_type:sync_configuration_type -> role_arn:string -> resource_name:string -> repository_link_id:string -> config_file:string -> branch:string -> unit -> create_sync_configuration_input
val make_create_host_output : ?tags:tag list -> ?host_arn:string -> unit -> create_host_output

Create a create_host_output type

val make_create_host_input : ?tags:tag list -> ?vpc_configuration:vpc_configuration -> provider_endpoint:string -> provider_type:provider_type -> name:string -> unit -> create_host_input

Create a create_host_input type

val make_create_connection_output : ?tags:tag list -> connection_arn:string -> unit -> create_connection_output
val make_create_connection_input : ?host_arn:string -> ?tags:tag list -> ?provider_type:provider_type -> connection_name:string -> unit -> create_connection_input

Operations

module CreateConnection : sig ... end
module CreateHost : sig ... end
module CreateSyncConfiguration : sig ... end
module DeleteConnection : sig ... end
module DeleteHost : sig ... end
module DeleteSyncConfiguration : sig ... end
module GetConnection : sig ... end
module GetHost : sig ... end
module GetRepositorySyncStatus : sig ... end
module GetResourceSyncStatus : sig ... end
module GetSyncBlockerSummary : sig ... end
module GetSyncConfiguration : sig ... end
module ListConnections : sig ... end
module ListHosts : sig ... end
module ListRepositorySyncDefinitions : sig ... end
module ListSyncConfigurations : sig ... end
module ListTagsForResource : sig ... end
module TagResource : sig ... end
module UntagResource : sig ... end
module UpdateHost : sig ... end
module UpdateSyncBlocker : sig ... end
module UpdateSyncConfiguration : sig ... end