We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.CodeStarconnections

Inherits:
AWS.Service show all
Identifier:
codestarconnections
API Version:
2019-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This Amazon Web Services CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the Amazon Web Services CodeStar Connections 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:

  • CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

  • DeleteConnection, which deletes the specified connection.

  • GetConnection, which returns information about the connection, including the connection status.

  • ListConnections, which lists the connections associated with your account.

You can work with hosts by calling:

  • CreateHost, which creates a host that represents the infrastructure where your provider is installed.

  • DeleteHost, which deletes the specified host.

  • GetHost, which returns information about the host, including the setup status.

  • ListHosts, which lists the hosts associated with your account.

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

  • ListTagsForResource, which gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Amazon Web Services CodeStar Connections.

  • TagResource, which adds or updates tags for a resource in Amazon Web Services CodeStar Connections.

  • UntagResource, which removes tags for a resource in Amazon Web Services CodeStar Connections.

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

Sending a Request Using CodeStarconnections

var codestarconnections = new AWS.CodeStarconnections();
codestarconnections.createConnection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeStarconnections object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codestarconnections = new AWS.CodeStarconnections({apiVersion: '2019-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the codestarconnections service identifier:

AWS.config.apiVersions = {
  codestarconnections: '2019-12-01',
  // other service API versions
};

var codestarconnections = new AWS.CodeStarconnections();

Version:

  • 2019-12-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeStarconnections(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodeStarconnections object

var codestarconnections = new AWS.CodeStarconnections({apiVersion: '2019-12-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.CodeStarconnections.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.CodeStarconnections.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CodeStarconnections.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createConnection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createConnection operation

var params = {
  ConnectionName: 'STRING_VALUE', /* required */
  HostArn: 'STRING_VALUE',
  ProviderType: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codestarconnections.createConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProviderType — (String)

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

      Possible values include:
      • "Bitbucket"
      • "GitHub"
      • "GitHubEnterpriseServer"
      • "GitLab"
      • "GitLabSelfManaged"
    • ConnectionName — (String)

      The name of the connection to be created.

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

    • HostArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ConnectionArn — (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.

        Note: The ARN is never reused if the connection is deleted.
      • Tags — (Array<map>)

        Specifies the tags applied to the resource.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createHost(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

Calling the createHost operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ProviderEndpoint: 'STRING_VALUE', /* required */
  ProviderType: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged, /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE', /* required */
    TlsCertificate: 'STRING_VALUE'
  }
};
codestarconnections.createHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the host to be created.

    • ProviderType — (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.

      Possible values include:
      • "Bitbucket"
      • "GitHub"
      • "GitHubEnterpriseServer"
      • "GitLab"
      • "GitLabSelfManaged"
    • ProviderEndpoint — (String)

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

    • VpcConfiguration — (map)

      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.

      • VpcIdrequired — (String)

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

      • SubnetIdsrequired — (Array<String>)

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

      • SecurityGroupIdsrequired — (Array<String>)

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

      • TlsCertificate — (String)

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

    • Tags — (Array<map>)

      Tags for the host to be created.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HostArn — (String)

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

      • Tags — (Array<map>)

        Tags for the created host.

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the createRepositoryLink operation

var params = {
  ConnectionArn: 'STRING_VALUE', /* required */
  OwnerId: 'STRING_VALUE', /* required */
  RepositoryName: 'STRING_VALUE', /* required */
  EncryptionKeyArn: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codestarconnections.createRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionArn — (String)

      The Amazon Resource Name (ARN) of the connection to be associated with the repository link.

    • OwnerId — (String)

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

    • RepositoryName — (String)

      The name of the repository to be associated with the repository link.

    • EncryptionKeyArn — (String)

      The Amazon Resource Name (ARN) encryption key for the repository to be associated with the repository link.

    • Tags — (Array<map>)

      The tags for the repository to be associated with the repository link.

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryLinkInfo — (map)

        The returned information about the created repository link.

        • ConnectionArnrequired — (String)

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

        • EncryptionKeyArn — (String)

          The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

        • OwnerIdrequired — (String)

          The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

        • ProviderTyperequired — (String)

          The provider type for the connection, such as GitHub, associated with the repository link.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkArnrequired — (String)

          The Amazon Resource Name (ARN) of the repository link.

        • RepositoryLinkIdrequired — (String)

          The ID of the repository link.

        • RepositoryNamerequired — (String)

          The name of the repository associated with the repository link.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createSyncConfiguration operation

var params = {
  Branch: 'STRING_VALUE', /* required */
  ConfigFile: 'STRING_VALUE', /* required */
  RepositoryLinkId: 'STRING_VALUE', /* required */
  ResourceName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  PublishDeploymentStatus: ENABLED | DISABLED,
  TriggerResourceUpdateOn: ANY_CHANGE | FILE_CHANGE
};
codestarconnections.createSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Branch — (String)

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

    • ConfigFile — (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.

    • RepositoryLinkId — (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 — (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 — (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 — (String)

      The type of sync configuration.

      Possible values include:
      • "CFN_STACK_SYNC"
    • PublishDeploymentStatus — (String)

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

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • TriggerResourceUpdateOn — (String)

      When to trigger Git sync to begin the stack update.

      Possible values include:
      • "ANY_CHANGE"
      • "FILE_CHANGE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyncConfiguration — (map)

        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.

        • Branchrequired — (String)

          The branch associated with a specific sync configuration.

        • ConfigFile — (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.

        • OwnerIdrequired — (String)

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

        • ProviderTyperequired — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkIdrequired — (String)

          The ID of the repository link associated with a specific sync configuration.

        • RepositoryNamerequired — (String)

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

        • ResourceNamerequired — (String)

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

        • RoleArnrequired — (String)

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

        • SyncTyperequired — (String)

          The type of sync for a specific sync configuration.

          Possible values include:
          • "CFN_STACK_SYNC"
        • PublishDeploymentStatus — (String)

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

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • TriggerResourceUpdateOn — (String)

          When to trigger Git sync to begin the stack update.

          Possible values include:
          • "ANY_CHANGE"
          • "FILE_CHANGE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteConnection(params = {}, callback) ⇒ AWS.Request

The connection to be deleted.

Service Reference:

Examples:

Calling the deleteConnection operation

var params = {
  ConnectionArn: 'STRING_VALUE' /* required */
};
codestarconnections.deleteConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionArn — (String)

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

      Note: The ARN is never reused if the connection is deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteHost(params = {}, callback) ⇒ AWS.Request

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

Note: A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

Service Reference:

Examples:

Calling the deleteHost operation

var params = {
  HostArn: 'STRING_VALUE' /* required */
};
codestarconnections.deleteHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the deleteRepositoryLink operation

var params = {
  RepositoryLinkId: 'STRING_VALUE' /* required */
};
codestarconnections.deleteRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RepositoryLinkId — (String)

      The ID of the repository link to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSyncConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the sync configuration for a specified repository and connection.

Service Reference:

Examples:

Calling the deleteSyncConfiguration operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.deleteSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SyncType — (String)

      The type of sync configuration to be deleted.

      Possible values include:
      • "CFN_STACK_SYNC"
    • ResourceName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getConnection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getConnection operation

var params = {
  ConnectionArn: 'STRING_VALUE' /* required */
};
codestarconnections.getConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionArn — (String)

      The Amazon Resource Name (ARN) of a connection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connection — (map)

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

        • ConnectionName — (String)

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

        • ConnectionArn — (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.

          Note: The ARN is never reused if the connection is deleted.
        • ProviderType — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • OwnerAccountId — (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.

        • ConnectionStatus — (String)

          The current status of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "ERROR"
        • HostArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getHost(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getHost operation

var params = {
  HostArn: 'STRING_VALUE' /* required */
};
codestarconnections.getHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        The name of the requested host.

      • Status — (String)

        The status of the requested host.

      • ProviderType — (String)

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

        Possible values include:
        • "Bitbucket"
        • "GitHub"
        • "GitHubEnterpriseServer"
        • "GitLab"
        • "GitLabSelfManaged"
      • ProviderEndpoint — (String)

        The endpoint of the infrastructure represented by the requested host.

      • VpcConfiguration — (map)

        The VPC configuration of the requested host.

        • VpcIdrequired — (String)

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

        • SubnetIdsrequired — (Array<String>)

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

        • SecurityGroupIdsrequired — (Array<String>)

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

        • TlsCertificate — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Service Reference:

Examples:

Calling the getRepositoryLink operation

var params = {
  RepositoryLinkId: 'STRING_VALUE' /* required */
};
codestarconnections.getRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RepositoryLinkId — (String)

      The ID of the repository link to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryLinkInfo — (map)

        The information returned for a specified repository link.

        • ConnectionArnrequired — (String)

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

        • EncryptionKeyArn — (String)

          The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

        • OwnerIdrequired — (String)

          The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

        • ProviderTyperequired — (String)

          The provider type for the connection, such as GitHub, associated with the repository link.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkArnrequired — (String)

          The Amazon Resource Name (ARN) of the repository link.

        • RepositoryLinkIdrequired — (String)

          The ID of the repository link.

        • RepositoryNamerequired — (String)

          The name of the repository associated with the repository link.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRepositorySyncStatus(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getRepositorySyncStatus operation

var params = {
  Branch: 'STRING_VALUE', /* required */
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.getRepositorySyncStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Branch — (String)

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

    • RepositoryLinkId — (String)

      The repository link ID for the requested repository sync status.

    • SyncType — (String)

      The sync type of the requested sync status.

      Possible values include:
      • "CFN_STACK_SYNC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LatestSync — (map)

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

        • StartedAtrequired — (Date)

          The start time of a specific sync attempt.

        • Statusrequired — (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.

          Possible values include:
          • "FAILED"
          • "INITIATED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "QUEUED"
        • Eventsrequired — (Array<map>)

          The events associated with a specific sync attempt.

          • Eventrequired — (String)

            A description of a repository sync event.

          • ExternalId — (String)

            The ID for a repository sync event.

          • Timerequired — (Date)

            The time that a repository sync event occurred.

          • Typerequired — (String)

            The event type for a repository sync event.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourceSyncStatus(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getResourceSyncStatus operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.getResourceSyncStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceName — (String)

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

    • SyncType — (String)

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

      Possible values include:
      • "CFN_STACK_SYNC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DesiredState — (map)

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

        • Branchrequired — (String)

          The branch name for a specific revision.

        • Directoryrequired — (String)

          The directory, if any, for a specific revision.

        • OwnerIdrequired — (String)

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

        • RepositoryNamerequired — (String)

          The repository name for a specific revision.

        • ProviderTyperequired — (String)

          The provider type for a revision, such as GitHub.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • Sharequired — (String)

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

      • LatestSuccessfulSync — (map)

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

        • Eventsrequired — (Array<map>)

          The events related to a resource sync attempt.

          • Eventrequired — (String)

            The event for a resource sync event.

          • ExternalId — (String)

            The ID for a resource sync event.

          • Timerequired — (Date)

            The time that a resource sync event occurred.

          • Typerequired — (String)

            The type of resource sync event.

        • InitialRevisionrequired — (map)

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

          • Branchrequired — (String)

            The branch name for a specific revision.

          • Directoryrequired — (String)

            The directory, if any, for a specific revision.

          • OwnerIdrequired — (String)

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

          • RepositoryNamerequired — (String)

            The repository name for a specific revision.

          • ProviderTyperequired — (String)

            The provider type for a revision, such as GitHub.

            Possible values include:
            • "Bitbucket"
            • "GitHub"
            • "GitHubEnterpriseServer"
            • "GitLab"
            • "GitLabSelfManaged"
          • Sharequired — (String)

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

        • StartedAtrequired — (Date)

          The start time for a resource sync attempt.

        • Statusrequired — (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.

          Possible values include:
          • "FAILED"
          • "INITIATED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
        • TargetRevisionrequired — (map)

          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.

          • Branchrequired — (String)

            The branch name for a specific revision.

          • Directoryrequired — (String)

            The directory, if any, for a specific revision.

          • OwnerIdrequired — (String)

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

          • RepositoryNamerequired — (String)

            The repository name for a specific revision.

          • ProviderTyperequired — (String)

            The provider type for a revision, such as GitHub.

            Possible values include:
            • "Bitbucket"
            • "GitHub"
            • "GitHubEnterpriseServer"
            • "GitLab"
            • "GitLabSelfManaged"
          • Sharequired — (String)

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

        • Targetrequired — (String)

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

      • LatestSync — (map)

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

        • Eventsrequired — (Array<map>)

          The events related to a resource sync attempt.

          • Eventrequired — (String)

            The event for a resource sync event.

          • ExternalId — (String)

            The ID for a resource sync event.

          • Timerequired — (Date)

            The time that a resource sync event occurred.

          • Typerequired — (String)

            The type of resource sync event.

        • InitialRevisionrequired — (map)

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

          • Branchrequired — (String)

            The branch name for a specific revision.

          • Directoryrequired — (String)

            The directory, if any, for a specific revision.

          • OwnerIdrequired — (String)

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

          • RepositoryNamerequired — (String)

            The repository name for a specific revision.

          • ProviderTyperequired — (String)

            The provider type for a revision, such as GitHub.

            Possible values include:
            • "Bitbucket"
            • "GitHub"
            • "GitHubEnterpriseServer"
            • "GitLab"
            • "GitLabSelfManaged"
          • Sharequired — (String)

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

        • StartedAtrequired — (Date)

          The start time for a resource sync attempt.

        • Statusrequired — (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.

          Possible values include:
          • "FAILED"
          • "INITIATED"
          • "IN_PROGRESS"
          • "SUCCEEDED"
        • TargetRevisionrequired — (map)

          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.

          • Branchrequired — (String)

            The branch name for a specific revision.

          • Directoryrequired — (String)

            The directory, if any, for a specific revision.

          • OwnerIdrequired — (String)

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

          • RepositoryNamerequired — (String)

            The repository name for a specific revision.

          • ProviderTyperequired — (String)

            The provider type for a revision, such as GitHub.

            Possible values include:
            • "Bitbucket"
            • "GitHub"
            • "GitHubEnterpriseServer"
            • "GitLab"
            • "GitLabSelfManaged"
          • Sharequired — (String)

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

        • Targetrequired — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSyncBlockerSummary(params = {}, callback) ⇒ AWS.Request

Returns a list of the most recent sync blockers.

Service Reference:

Examples:

Calling the getSyncBlockerSummary operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.getSyncBlockerSummary(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SyncType — (String)

      The sync type for the sync blocker summary.

      Possible values include:
      • "CFN_STACK_SYNC"
    • ResourceName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyncBlockerSummary — (map)

        The list of sync blockers for a specified resource.

        • ResourceNamerequired — (String)

          The resource name for sync blocker summary.

        • ParentResourceName — (String)

          The parent resource name for a sync blocker summary.

        • LatestBlockers — (Array<map>)

          The latest events for a sync blocker summary.

          • Idrequired — (String)

            The ID for a specific sync blocker.

          • Typerequired — (String)

            The sync blocker type.

            Possible values include:
            • "AUTOMATED"
          • Statusrequired — (String)

            The status for a specific sync blocker.

            Possible values include:
            • "ACTIVE"
            • "RESOLVED"
          • CreatedReasonrequired — (String)

            The provided reason for a specific sync blocker.

          • CreatedAtrequired — (Date)

            The creation time for a specific sync blocker.

          • Contexts — (Array<map>)

            The contexts for a specific sync blocker.

            • Keyrequired — (String)

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

            • Valuerequired — (String)

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

          • ResolvedReason — (String)

            The resolved reason for a specific sync blocker.

          • ResolvedAt — (Date)

            The time that a specific sync blocker was resolved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getSyncConfiguration operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.getSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SyncType — (String)

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

      Possible values include:
      • "CFN_STACK_SYNC"
    • ResourceName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyncConfiguration — (map)

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

        • Branchrequired — (String)

          The branch associated with a specific sync configuration.

        • ConfigFile — (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.

        • OwnerIdrequired — (String)

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

        • ProviderTyperequired — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkIdrequired — (String)

          The ID of the repository link associated with a specific sync configuration.

        • RepositoryNamerequired — (String)

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

        • ResourceNamerequired — (String)

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

        • RoleArnrequired — (String)

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

        • SyncTyperequired — (String)

          The type of sync for a specific sync configuration.

          Possible values include:
          • "CFN_STACK_SYNC"
        • PublishDeploymentStatus — (String)

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

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • TriggerResourceUpdateOn — (String)

          When to trigger Git sync to begin the stack update.

          Possible values include:
          • "ANY_CHANGE"
          • "FILE_CHANGE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listConnections(params = {}, callback) ⇒ AWS.Request

Lists the connections associated with your account.

Service Reference:

Examples:

Calling the listConnections operation

var params = {
  HostArnFilter: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProviderTypeFilter: Bitbucket | GitHub | GitHubEnterpriseServer | GitLab | GitLabSelfManaged
};
codestarconnections.listConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ProviderTypeFilter — (String)

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

      Possible values include:
      • "Bitbucket"
      • "GitHub"
      • "GitHubEnterpriseServer"
      • "GitLab"
      • "GitLabSelfManaged"
    • HostArnFilter — (String)

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

    • MaxResults — (Integer)

      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 — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Connections — (Array<map>)

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

        • ConnectionName — (String)

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

        • ConnectionArn — (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.

          Note: The ARN is never reused if the connection is deleted.
        • ProviderType — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • OwnerAccountId — (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.

        • ConnectionStatus — (String)

          The current status of the connection.

          Possible values include:
          • "PENDING"
          • "AVAILABLE"
          • "ERROR"
        • HostArn — (String)

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

      • NextToken — (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 more nextToken values are returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHosts(params = {}, callback) ⇒ AWS.Request

Lists the hosts associated with your account.

Service Reference:

Examples:

Calling the listHosts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarconnections.listHosts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      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 — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Hosts — (Array<map>)

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

        • Name — (String)

          The name of the host.

        • HostArn — (String)

          The Amazon Resource Name (ARN) of the host.

        • ProviderType — (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.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • ProviderEndpoint — (String)

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

        • VpcConfiguration — (map)

          The VPC configuration provisioned for the host.

          • VpcIdrequired — (String)

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

          • SubnetIdsrequired — (Array<String>)

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

          • SecurityGroupIdsrequired — (Array<String>)

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

          • TlsCertificate — (String)

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

        • Status — (String)

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

        • StatusMessage — (String)

          The status description for the host.

      • NextToken — (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 more nextToken values are returned.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

Lists the repository links created for connections in your account.

Service Reference:

Examples:

Calling the listRepositoryLinks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarconnections.listRepositoryLinks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryLinks — (Array<map>)

        Lists the repository links called by the list repository links operation.

        • ConnectionArnrequired — (String)

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

        • EncryptionKeyArn — (String)

          The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

        • OwnerIdrequired — (String)

          The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

        • ProviderTyperequired — (String)

          The provider type for the connection, such as GitHub, associated with the repository link.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkArnrequired — (String)

          The Amazon Resource Name (ARN) of the repository link.

        • RepositoryLinkIdrequired — (String)

          The ID of the repository link.

        • RepositoryNamerequired — (String)

          The name of the repository associated with the repository link.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRepositorySyncDefinitions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRepositorySyncDefinitions operation

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.listRepositorySyncDefinitions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RepositoryLinkId — (String)

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

    • SyncType — (String)

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

      Possible values include:
      • "CFN_STACK_SYNC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositorySyncDefinitions — (Array<map>)

        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.

        • Branchrequired — (String)

          The branch specified for a repository sync definition.

        • Directoryrequired — (String)

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

        • Parentrequired — (String)

          The parent resource specified for a repository sync definition.

        • Targetrequired — (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.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSyncConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of sync configurations for a specified repository.

Service Reference:

Examples:

Calling the listSyncConfigurations operation

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
codestarconnections.listSyncConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

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

    • NextToken — (String)

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

    • RepositoryLinkId — (String)

      The ID of the repository link for the requested list of sync configurations.

    • SyncType — (String)

      The sync type for the requested list of sync configurations.

      Possible values include:
      • "CFN_STACK_SYNC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyncConfigurations — (Array<map>)

        The list of repository sync definitions returned by the request.

        • Branchrequired — (String)

          The branch associated with a specific sync configuration.

        • ConfigFile — (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.

        • OwnerIdrequired — (String)

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

        • ProviderTyperequired — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkIdrequired — (String)

          The ID of the repository link associated with a specific sync configuration.

        • RepositoryNamerequired — (String)

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

        • ResourceNamerequired — (String)

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

        • RoleArnrequired — (String)

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

        • SyncTyperequired — (String)

          The type of sync for a specific sync configuration.

          Possible values include:
          • "CFN_STACK_SYNC"
        • PublishDeploymentStatus — (String)

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

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • TriggerResourceUpdateOn — (String)

          When to trigger Git sync to begin the stack update.

          Possible values include:
          • "ANY_CHANGE"
          • "FILE_CHANGE"
      • NextToken — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
codestarconnections.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

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

        • Keyrequired — (String)

          The tag's key.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codestarconnections.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • Tags — (Array<map>)

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

      • Keyrequired — (String)

        The tag's key.

      • Valuerequired — (String)

        The tag's value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from an Amazon Web Services resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codestarconnections.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • TagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateHost(params = {}, callback) ⇒ AWS.Request

Updates a specified host with the provided configurations.

Service Reference:

Examples:

Calling the updateHost operation

var params = {
  HostArn: 'STRING_VALUE', /* required */
  ProviderEndpoint: 'STRING_VALUE',
  VpcConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    VpcId: 'STRING_VALUE', /* required */
    TlsCertificate: 'STRING_VALUE'
  }
};
codestarconnections.updateHost(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • HostArn — (String)

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

    • ProviderEndpoint — (String)

      The URL or endpoint of the host to be updated.

    • VpcConfiguration — (map)

      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.

      • VpcIdrequired — (String)

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

      • SubnetIdsrequired — (Array<String>)

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

      • SecurityGroupIdsrequired — (Array<String>)

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

      • TlsCertificate — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateRepositoryLink operation

var params = {
  RepositoryLinkId: 'STRING_VALUE', /* required */
  ConnectionArn: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE'
};
codestarconnections.updateRepositoryLink(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ConnectionArn — (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 — (String)

      The Amazon Resource Name (ARN) of the encryption key for the repository link to be updated.

    • RepositoryLinkId — (String)

      The ID of the repository link to be updated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RepositoryLinkInfo — (map)

        Information about the repository link to be updated.

        • ConnectionArnrequired — (String)

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

        • EncryptionKeyArn — (String)

          The Amazon Resource Name (ARN) of the encryption key for the repository associated with the repository link.

        • OwnerIdrequired — (String)

          The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.

        • ProviderTyperequired — (String)

          The provider type for the connection, such as GitHub, associated with the repository link.

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkArnrequired — (String)

          The Amazon Resource Name (ARN) of the repository link.

        • RepositoryLinkIdrequired — (String)

          The ID of the repository link.

        • RepositoryNamerequired — (String)

          The name of the repository associated with the repository link.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSyncBlocker(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSyncBlocker operation

var params = {
  Id: 'STRING_VALUE', /* required */
  ResolvedReason: 'STRING_VALUE', /* required */
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC /* required */
};
codestarconnections.updateSyncBlocker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String)

      The ID of the sync blocker to be updated.

    • SyncType — (String)

      The sync type of the sync blocker to be updated.

      Possible values include:
      • "CFN_STACK_SYNC"
    • ResourceName — (String)

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

    • ResolvedReason — (String)

      The reason for resolving the sync blocker.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceName — (String)

        The resource name for the sync blocker.

      • ParentResourceName — (String)

        The parent resource name for the sync blocker.

      • SyncBlocker — (map)

        Information about the sync blocker to be updated.

        • Idrequired — (String)

          The ID for a specific sync blocker.

        • Typerequired — (String)

          The sync blocker type.

          Possible values include:
          • "AUTOMATED"
        • Statusrequired — (String)

          The status for a specific sync blocker.

          Possible values include:
          • "ACTIVE"
          • "RESOLVED"
        • CreatedReasonrequired — (String)

          The provided reason for a specific sync blocker.

        • CreatedAtrequired — (Date)

          The creation time for a specific sync blocker.

        • Contexts — (Array<map>)

          The contexts for a specific sync blocker.

          • Keyrequired — (String)

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

          • Valuerequired — (String)

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

        • ResolvedReason — (String)

          The resolved reason for a specific sync blocker.

        • ResolvedAt — (Date)

          The time that a specific sync blocker was resolved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSyncConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSyncConfiguration operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  SyncType: CFN_STACK_SYNC, /* required */
  Branch: 'STRING_VALUE',
  ConfigFile: 'STRING_VALUE',
  PublishDeploymentStatus: ENABLED | DISABLED,
  RepositoryLinkId: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  TriggerResourceUpdateOn: ANY_CHANGE | FILE_CHANGE
};
codestarconnections.updateSyncConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Branch — (String)

      The branch for the sync configuration to be updated.

    • ConfigFile — (String)

      The configuration file for the sync configuration to be updated.

    • RepositoryLinkId — (String)

      The ID of the repository link for the sync configuration to be updated.

    • ResourceName — (String)

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

    • RoleArn — (String)

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

    • SyncType — (String)

      The sync type for the sync configuration to be updated.

      Possible values include:
      • "CFN_STACK_SYNC"
    • PublishDeploymentStatus — (String)

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

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • TriggerResourceUpdateOn — (String)

      When to trigger Git sync to begin the stack update.

      Possible values include:
      • "ANY_CHANGE"
      • "FILE_CHANGE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SyncConfiguration — (map)

        The information returned for the sync configuration to be updated.

        • Branchrequired — (String)

          The branch associated with a specific sync configuration.

        • ConfigFile — (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.

        • OwnerIdrequired — (String)

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

        • ProviderTyperequired — (String)

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

          Possible values include:
          • "Bitbucket"
          • "GitHub"
          • "GitHubEnterpriseServer"
          • "GitLab"
          • "GitLabSelfManaged"
        • RepositoryLinkIdrequired — (String)

          The ID of the repository link associated with a specific sync configuration.

        • RepositoryNamerequired — (String)

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

        • ResourceNamerequired — (String)

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

        • RoleArnrequired — (String)

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

        • SyncTyperequired — (String)

          The type of sync for a specific sync configuration.

          Possible values include:
          • "CFN_STACK_SYNC"
        • PublishDeploymentStatus — (String)

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

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • TriggerResourceUpdateOn — (String)

          When to trigger Git sync to begin the stack update.

          Possible values include:
          • "ANY_CHANGE"
          • "FILE_CHANGE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.