AWS API Changes

2023/12/28 - AWS CodeStar connections - 15 updated api methods

Changes New integration with the GitLab self-managed provider type.

CreateConnection (updated)

Link ¶
Changes (request)

{'ProviderType': {'GitLabSelfManaged'}}

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.

See also: AWS API Documentation

Request Syntax

client.create_connection(
    ProviderType='Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
    ConnectionName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    HostArn='string'
)

type ProviderType:

string

param ProviderType:

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

type ConnectionName:

string

param ConnectionName:

[REQUIRED]

The name of the connection to be created.

type Tags:

list

param Tags:

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

(dict) --

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by Amazon Web Services services that support tags.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

type HostArn:

string

param HostArn:

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

rtype:

dict

returns:

Response Syntax

{
    'ConnectionArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- 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 (list) --
  
  Specifies the tags applied to the resource.
  - (dict) --
    
    A tag is a key-value pair that is used to manage the resource.
    
    This tag is available for use by Amazon Web Services services that support tags.
    - Key (string) --
      
      The tag's key.
    - Value (string) --
      
      The tag's value.

CreateHost (updated)

Link ¶
Changes (request)

{'ProviderType': {'GitLabSelfManaged'}}

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.

See also: AWS API Documentation

Request Syntax

client.create_host(
    Name='string',
    ProviderType='Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
    ProviderEndpoint='string',
    VpcConfiguration={
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

The name of the host to be created.

type ProviderType:

string

param ProviderType:

[REQUIRED]

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.

type ProviderEndpoint:

string

param ProviderEndpoint:

[REQUIRED]

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

type VpcConfiguration:

dict

param VpcConfiguration:

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.

VpcId (string) -- [REQUIRED]

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
SubnetIds (list) -- [REQUIRED]

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
- (string) --
SecurityGroupIds (list) -- [REQUIRED]

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

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

type Tags:

list

param Tags:

Tags for the host to be created.

(dict) --

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by Amazon Web Services services that support tags.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

rtype:

dict

returns:

Response Syntax

{
    'HostArn': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- HostArn (string) --
  
  The Amazon Resource Name (ARN) of the host to be created.
- Tags (list) --
  
  Tags for the created host.
  - (dict) --
    
    A tag is a key-value pair that is used to manage the resource.
    
    This tag is available for use by Amazon Web Services services that support tags.
    - Key (string) --
      
      The tag's key.
    - Value (string) --
      
      The tag's value.

CreateRepositoryLink (updated)

Link ¶
Changes (response)

{'RepositoryLinkInfo': {'ProviderType': {'GitLabSelfManaged'}}}

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.

See also: AWS API Documentation

Request Syntax

client.create_repository_link(
    ConnectionArn='string',
    OwnerId='string',
    RepositoryName='string',
    EncryptionKeyArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ConnectionArn:

string

param ConnectionArn:

[REQUIRED]

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

type OwnerId:

string

param OwnerId:

[REQUIRED]

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

type RepositoryName:

string

param RepositoryName:

[REQUIRED]

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

type EncryptionKeyArn:

string

param EncryptionKeyArn:

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

type Tags:

list

param Tags:

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

(dict) --

A tag is a key-value pair that is used to manage the resource.

This tag is available for use by Amazon Web Services services that support tags.
- Key (string) -- [REQUIRED]
  
  The tag's key.
- Value (string) -- [REQUIRED]
  
  The tag's value.

rtype:

dict

returns:

Response Syntax

{
    'RepositoryLinkInfo': {
        'ConnectionArn': 'string',
        'EncryptionKeyArn': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkArn': 'string',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string'
    }
}

Response Structure

(dict) --
- RepositoryLinkInfo (dict) --
  
  The returned information about the created repository link.
  - ConnectionArn (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The provider type for the connection, such as GitHub, associated with the repository link.
  - RepositoryLinkArn (string) --
    
    The Amazon Resource Name (ARN) of the repository link.
  - RepositoryLinkId (string) --
    
    The ID of the repository link.
  - RepositoryName (string) --
    
    The name of the repository associated with the repository link.

CreateSyncConfiguration (updated)

Link ¶
Changes (response)

{'SyncConfiguration': {'ProviderType': {'GitLabSelfManaged'}}}

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.

See also: AWS API Documentation

Request Syntax

client.create_sync_configuration(
    Branch='string',
    ConfigFile='string',
    RepositoryLinkId='string',
    ResourceName='string',
    RoleArn='string',
    SyncType='CFN_STACK_SYNC'
)

type Branch:

string

param Branch:

[REQUIRED]

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

type ConfigFile:

string

param ConfigFile:

[REQUIRED]

The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

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.

type ResourceName:

string

param ResourceName:

[REQUIRED]

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.

type RoleArn:

string

param RoleArn:

[REQUIRED]

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.

type SyncType:

string

param SyncType:

[REQUIRED]

The type of sync configuration.

rtype:

dict

returns:

Response Syntax

{
    'SyncConfiguration': {
        'Branch': 'string',
        'ConfigFile': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string',
        'ResourceName': 'string',
        'RoleArn': 'string',
        'SyncType': 'CFN_STACK_SYNC'
    }
}

Response Structure

(dict) --
- SyncConfiguration (dict) --
  
  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.
  - Branch (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The connection provider type associated with a specific sync configuration, such as GitHub.
  - RepositoryLinkId (string) --
    
    The ID of the repository link associated with a specific sync configuration.
  - RepositoryName (string) --
    
    The name of the repository associated with a specific sync configuration.
  - ResourceName (string) --
    
    The name of the connection resource associated with a specific sync configuration.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
  - SyncType (string) --
    
    The type of sync for a specific sync configuration.

GetConnection (updated)

Link ¶
Changes (response)

{'Connection': {'ProviderType': {'GitLabSelfManaged'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_connection(
    ConnectionArn='string'
)

type ConnectionArn:

string

param ConnectionArn:

[REQUIRED]

The Amazon Resource Name (ARN) of a connection.

rtype:

dict

returns:

Response Syntax

{
    'Connection': {
        'ConnectionName': 'string',
        'ConnectionArn': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'OwnerAccountId': 'string',
        'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR',
        'HostArn': 'string'
    }
}

Response Structure

(dict) --
- Connection (dict) --
  
  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.
  - 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.
  - HostArn (string) --
    
    The Amazon Resource Name (ARN) of the host associated with the connection.

GetHost (updated)

Link ¶
Changes (response)

{'ProviderType': {'GitLabSelfManaged'}}

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

See also: AWS API Documentation

Request Syntax

client.get_host(
    HostArn='string'
)

type HostArn:

string

param HostArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Name': 'string',
    'Status': 'string',
    'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
    'ProviderEndpoint': 'string',
    'VpcConfiguration': {
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'TlsCertificate': 'string'
    }
}

Response Structure

(dict) --
- 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.
- ProviderEndpoint (string) --
  
  The endpoint of the infrastructure represented by the requested host.
- VpcConfiguration (dict) --
  
  The VPC configuration of the requested host.
  - VpcId (string) --
    
    The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
  - SubnetIds (list) --
    
    The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
    - (string) --
  - SecurityGroupIds (list) --
    
    The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
    - (string) --
  - TlsCertificate (string) --
    
    The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

GetRepositoryLink (updated)

Link ¶
Changes (response)

{'RepositoryLinkInfo': {'ProviderType': {'GitLabSelfManaged'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_repository_link(
    RepositoryLinkId='string'
)

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

The ID of the repository link to get.

rtype:

dict

returns:

Response Syntax

{
    'RepositoryLinkInfo': {
        'ConnectionArn': 'string',
        'EncryptionKeyArn': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkArn': 'string',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string'
    }
}

Response Structure

(dict) --
- RepositoryLinkInfo (dict) --
  
  The information returned for a specified repository link.
  - ConnectionArn (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The provider type for the connection, such as GitHub, associated with the repository link.
  - RepositoryLinkArn (string) --
    
    The Amazon Resource Name (ARN) of the repository link.
  - RepositoryLinkId (string) --
    
    The ID of the repository link.
  - RepositoryName (string) --
    
    The name of the repository associated with the repository link.

GetResourceSyncStatus (updated)

Link ¶
Changes (response)

{'DesiredState': {'ProviderType': {'GitLabSelfManaged'}},
 'LatestSuccessfulSync': {'InitialRevision': {'ProviderType': {'GitLabSelfManaged'}},
                          'TargetRevision': {'ProviderType': {'GitLabSelfManaged'}}},
 'LatestSync': {'InitialRevision': {'ProviderType': {'GitLabSelfManaged'}},
                'TargetRevision': {'ProviderType': {'GitLabSelfManaged'}}}}

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

See also: AWS API Documentation

Request Syntax

client.get_resource_sync_status(
    ResourceName='string',
    SyncType='CFN_STACK_SYNC'
)

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

type SyncType:

string

param SyncType:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'DesiredState': {
        'Branch': 'string',
        'Directory': 'string',
        'OwnerId': 'string',
        'RepositoryName': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'Sha': 'string'
    },
    'LatestSuccessfulSync': {
        'Events': [
            {
                'Event': 'string',
                'ExternalId': 'string',
                'Time': datetime(2015, 1, 1),
                'Type': 'string'
            },
        ],
        'InitialRevision': {
            'Branch': 'string',
            'Directory': 'string',
            'OwnerId': 'string',
            'RepositoryName': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'Sha': 'string'
        },
        'StartedAt': datetime(2015, 1, 1),
        'Status': 'FAILED'|'INITIATED'|'IN_PROGRESS'|'SUCCEEDED',
        'TargetRevision': {
            'Branch': 'string',
            'Directory': 'string',
            'OwnerId': 'string',
            'RepositoryName': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'Sha': 'string'
        },
        'Target': 'string'
    },
    'LatestSync': {
        'Events': [
            {
                'Event': 'string',
                'ExternalId': 'string',
                'Time': datetime(2015, 1, 1),
                'Type': 'string'
            },
        ],
        'InitialRevision': {
            'Branch': 'string',
            'Directory': 'string',
            'OwnerId': 'string',
            'RepositoryName': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'Sha': 'string'
        },
        'StartedAt': datetime(2015, 1, 1),
        'Status': 'FAILED'|'INITIATED'|'IN_PROGRESS'|'SUCCEEDED',
        'TargetRevision': {
            'Branch': 'string',
            'Directory': 'string',
            'OwnerId': 'string',
            'RepositoryName': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'Sha': 'string'
        },
        'Target': 'string'
    }
}

Response Structure

(dict) --
- DesiredState (dict) --
  
  The desired state of the Amazon Web Services resource for the sync status with the Git repository.
  - Branch (string) --
    
    The branch name for a specific revision.
  - Directory (string) --
    
    The directory, if any, for a specific revision.
  - OwnerId (string) --
    
    The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
  - RepositoryName (string) --
    
    The repository name for a specific revision.
  - ProviderType (string) --
    
    The provider type for a revision, such as GitHub.
  - Sha (string) --
    
    The SHA, such as the commit ID, for a specific revision.
- LatestSuccessfulSync (dict) --
  
  The latest successful sync for the sync status with the Git repository.
  - Events (list) --
    
    The events related to a resource sync attempt.
    - (dict) --
      
      Information about a resource sync event for the resource associated with a sync configuration.
      - Event (string) --
        
        The event for a resource sync event.
      - ExternalId (string) --
        
        The ID for a resource sync event.
      - Time (datetime) --
        
        The time that a resource sync event occurred.
      - Type (string) --
        
        The type of resource sync event.
  - InitialRevision (dict) --
    
    The current state of the resource as defined in the resource's config-file in the linked repository.
    - Branch (string) --
      
      The branch name for a specific revision.
    - Directory (string) --
      
      The directory, if any, for a specific revision.
    - OwnerId (string) --
      
      The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
    - RepositoryName (string) --
      
      The repository name for a specific revision.
    - ProviderType (string) --
      
      The provider type for a revision, such as GitHub.
    - Sha (string) --
      
      The SHA, such as the commit ID, for a specific revision.
  - StartedAt (datetime) --
    
    The start time for a resource sync attempt.
  - Status (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.
  - TargetRevision (dict) --
    
    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.
    - Branch (string) --
      
      The branch name for a specific revision.
    - Directory (string) --
      
      The directory, if any, for a specific revision.
    - OwnerId (string) --
      
      The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
    - RepositoryName (string) --
      
      The repository name for a specific revision.
    - ProviderType (string) --
      
      The provider type for a revision, such as GitHub.
    - Sha (string) --
      
      The SHA, such as the commit ID, for a specific revision.
  - Target (string) --
    
    The name of the Amazon Web Services resource that is attempted to be synchronized.
- LatestSync (dict) --
  
  The latest sync for the sync status with the Git repository, whether successful or not.
  - Events (list) --
    
    The events related to a resource sync attempt.
    - (dict) --
      
      Information about a resource sync event for the resource associated with a sync configuration.
      - Event (string) --
        
        The event for a resource sync event.
      - ExternalId (string) --
        
        The ID for a resource sync event.
      - Time (datetime) --
        
        The time that a resource sync event occurred.
      - Type (string) --
        
        The type of resource sync event.
  - InitialRevision (dict) --
    
    The current state of the resource as defined in the resource's config-file in the linked repository.
    - Branch (string) --
      
      The branch name for a specific revision.
    - Directory (string) --
      
      The directory, if any, for a specific revision.
    - OwnerId (string) --
      
      The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
    - RepositoryName (string) --
      
      The repository name for a specific revision.
    - ProviderType (string) --
      
      The provider type for a revision, such as GitHub.
    - Sha (string) --
      
      The SHA, such as the commit ID, for a specific revision.
  - StartedAt (datetime) --
    
    The start time for a resource sync attempt.
  - Status (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.
  - TargetRevision (dict) --
    
    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.
    - Branch (string) --
      
      The branch name for a specific revision.
    - Directory (string) --
      
      The directory, if any, for a specific revision.
    - OwnerId (string) --
      
      The owner ID for a specific revision, such as the GitHub owner ID for a GitHub repository.
    - RepositoryName (string) --
      
      The repository name for a specific revision.
    - ProviderType (string) --
      
      The provider type for a revision, such as GitHub.
    - Sha (string) --
      
      The SHA, such as the commit ID, for a specific revision.
  - Target (string) --
    
    The name of the Amazon Web Services resource that is attempted to be synchronized.

GetSyncConfiguration (updated)

Link ¶
Changes (response)

{'SyncConfiguration': {'ProviderType': {'GitLabSelfManaged'}}}

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.

See also: AWS API Documentation

Request Syntax

client.get_sync_configuration(
    SyncType='CFN_STACK_SYNC',
    ResourceName='string'
)

type SyncType:

string

param SyncType:

[REQUIRED]

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

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'SyncConfiguration': {
        'Branch': 'string',
        'ConfigFile': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string',
        'ResourceName': 'string',
        'RoleArn': 'string',
        'SyncType': 'CFN_STACK_SYNC'
    }
}

Response Structure

(dict) --
- SyncConfiguration (dict) --
  
  The details about the sync configuration for which you want to retrieve information.
  - Branch (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The connection provider type associated with a specific sync configuration, such as GitHub.
  - RepositoryLinkId (string) --
    
    The ID of the repository link associated with a specific sync configuration.
  - RepositoryName (string) --
    
    The name of the repository associated with a specific sync configuration.
  - ResourceName (string) --
    
    The name of the connection resource associated with a specific sync configuration.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
  - SyncType (string) --
    
    The type of sync for a specific sync configuration.

ListConnections (updated)

Link ¶
Changes (request, response)
Request

{'ProviderTypeFilter': {'GitLabSelfManaged'}}

Response

{'Connections': {'ProviderType': {'GitLabSelfManaged'}}}

Lists the connections associated with your account.

See also: AWS API Documentation

Request Syntax

client.list_connections(
    ProviderTypeFilter='Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
    HostArnFilter='string',
    MaxResults=123,
    NextToken='string'
)

type ProviderTypeFilter:

string

param ProviderTypeFilter:

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

type HostArnFilter:

string

param HostArnFilter:

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

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'Connections': [
        {
            'ConnectionName': 'string',
            'ConnectionArn': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'OwnerAccountId': 'string',
            'ConnectionStatus': 'PENDING'|'AVAILABLE'|'ERROR',
            'HostArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Connections (list) --
  
  A list of connections and the details for each connection, such as status, owner, and provider type.
  - (dict) --
    
    A resource that is used to connect third-party source providers with services like CodePipeline.
    
    Note: A connection created through CloudFormation, the CLI, or the SDK is in PENDING status by default. You can make its status AVAILABLE by updating the connection in the console.
    - 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.
    - 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.
    - 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.

ListHosts (updated)

Link ¶
Changes (response)

{'Hosts': {'ProviderType': {'GitLabSelfManaged'}}}

Lists the hosts associated with your account.

See also: AWS API Documentation

Request Syntax

client.list_hosts(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'Hosts': [
        {
            'Name': 'string',
            'HostArn': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'ProviderEndpoint': 'string',
            'VpcConfiguration': {
                'VpcId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'TlsCertificate': 'string'
            },
            'Status': 'string',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Hosts (list) --
  
  A list of hosts and the details for each host, such as status, endpoint, and provider type.
  - (dict) --
    
    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.
    - 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.
    - ProviderEndpoint (string) --
      
      The endpoint of the infrastructure where your provider type is installed.
    - VpcConfiguration (dict) --
      
      The VPC configuration provisioned for the host.
      - VpcId (string) --
        
        The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.
      - SubnetIds (list) --
        
        The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
        
        (string) --
      - SecurityGroupIds (list) --
        
        The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.
        
        (string) --
      - 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.

ListRepositoryLinks (updated)

Link ¶
Changes (response)

{'RepositoryLinks': {'ProviderType': {'GitLabSelfManaged'}}}

Lists the repository links created for connections in your account.

See also: AWS API Documentation

Request Syntax

client.list_repository_links(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'RepositoryLinks': [
        {
            'ConnectionArn': 'string',
            'EncryptionKeyArn': 'string',
            'OwnerId': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'RepositoryLinkArn': 'string',
            'RepositoryLinkId': 'string',
            'RepositoryName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RepositoryLinks (list) --
  
  Lists the repository links called by the list repository links operation.
  - (dict) --
    
    Information about the repository link resource, such as the repository link ARN, the associated connection ARN, encryption key ARN, and owner ID.
    - ConnectionArn (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.
    - OwnerId (string) --
      
      The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
    - ProviderType (string) --
      
      The provider type for the connection, such as GitHub, associated with the repository link.
    - RepositoryLinkArn (string) --
      
      The Amazon Resource Name (ARN) of the repository link.
    - RepositoryLinkId (string) --
      
      The ID of the repository link.
    - RepositoryName (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.

ListSyncConfigurations (updated)

Link ¶
Changes (response)

{'SyncConfigurations': {'ProviderType': {'GitLabSelfManaged'}}}

Returns a list of sync configurations for a specified repository.

See also: AWS API Documentation

Request Syntax

client.list_sync_configurations(
    MaxResults=123,
    NextToken='string',
    RepositoryLinkId='string',
    SyncType='CFN_STACK_SYNC'
)

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

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

type SyncType:

string

param SyncType:

[REQUIRED]

The sync type for the requested list of sync configurations.

rtype:

dict

returns:

Response Syntax

{
    'SyncConfigurations': [
        {
            'Branch': 'string',
            'ConfigFile': 'string',
            'OwnerId': 'string',
            'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
            'RepositoryLinkId': 'string',
            'RepositoryName': 'string',
            'ResourceName': 'string',
            'RoleArn': 'string',
            'SyncType': 'CFN_STACK_SYNC'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SyncConfigurations (list) --
  
  The list of repository sync definitions returned by the request.
  - (dict) --
    
    Information, such as repository, branch, provider, and resource names for a specific sync configuration.
    - Branch (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.
    - OwnerId (string) --
      
      The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
    - ProviderType (string) --
      
      The connection provider type associated with a specific sync configuration, such as GitHub.
    - RepositoryLinkId (string) --
      
      The ID of the repository link associated with a specific sync configuration.
    - RepositoryName (string) --
      
      The name of the repository associated with a specific sync configuration.
    - ResourceName (string) --
      
      The name of the connection resource associated with a specific sync configuration.
    - RoleArn (string) --
      
      The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
    - SyncType (string) --
      
      The type of sync for a specific sync configuration.
- NextToken (string) --
  
  An enumeration token that allows the operation to batch the next results of the operation.

UpdateRepositoryLink (updated)

Link ¶
Changes (response)

{'RepositoryLinkInfo': {'ProviderType': {'GitLabSelfManaged'}}}

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.

See also: AWS API Documentation

Request Syntax

client.update_repository_link(
    ConnectionArn='string',
    EncryptionKeyArn='string',
    RepositoryLinkId='string'
)

type ConnectionArn:

string

param ConnectionArn:

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.

type EncryptionKeyArn:

string

param EncryptionKeyArn:

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

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

The ID of the repository link to be updated.

rtype:

dict

returns:

Response Syntax

{
    'RepositoryLinkInfo': {
        'ConnectionArn': 'string',
        'EncryptionKeyArn': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkArn': 'string',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string'
    }
}

Response Structure

(dict) --
- RepositoryLinkInfo (dict) --
  
  Information about the repository link to be updated.
  - ConnectionArn (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with the repository link, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The provider type for the connection, such as GitHub, associated with the repository link.
  - RepositoryLinkArn (string) --
    
    The Amazon Resource Name (ARN) of the repository link.
  - RepositoryLinkId (string) --
    
    The ID of the repository link.
  - RepositoryName (string) --
    
    The name of the repository associated with the repository link.

UpdateSyncConfiguration (updated)

Link ¶
Changes (response)

{'SyncConfiguration': {'ProviderType': {'GitLabSelfManaged'}}}

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

See also: AWS API Documentation

Request Syntax

client.update_sync_configuration(
    Branch='string',
    ConfigFile='string',
    RepositoryLinkId='string',
    ResourceName='string',
    RoleArn='string',
    SyncType='CFN_STACK_SYNC'
)

type Branch:

string

param Branch:

The branch for the sync configuration to be updated.

type ConfigFile:

string

param ConfigFile:

The configuration file for the sync configuration to be updated.

type RepositoryLinkId:

string

param RepositoryLinkId:

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

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

type RoleArn:

string

param RoleArn:

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

type SyncType:

string

param SyncType:

[REQUIRED]

The sync type for the sync configuration to be updated.

rtype:

dict

returns:

Response Syntax

{
    'SyncConfiguration': {
        'Branch': 'string',
        'ConfigFile': 'string',
        'OwnerId': 'string',
        'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
        'RepositoryLinkId': 'string',
        'RepositoryName': 'string',
        'ResourceName': 'string',
        'RoleArn': 'string',
        'SyncType': 'CFN_STACK_SYNC'
    }
}

Response Structure

(dict) --
- SyncConfiguration (dict) --
  
  The information returned for the sync configuration to be updated.
  - Branch (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.
  - OwnerId (string) --
    
    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.
  - ProviderType (string) --
    
    The connection provider type associated with a specific sync configuration, such as GitHub.
  - RepositoryLinkId (string) --
    
    The ID of the repository link associated with a specific sync configuration.
  - RepositoryName (string) --
    
    The name of the repository associated with a specific sync configuration.
  - ResourceName (string) --
    
    The name of the connection resource associated with a specific sync configuration.
  - RoleArn (string) --
    
    The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.
  - SyncType (string) --
    
    The type of sync for a specific sync configuration.