AWS API Changes

2023/11/27 - AWS CodeStar connections - 15 new api methods

Changes This release adds support for the CloudFormation Git sync feature. Git sync enables updating a CloudFormation stack from a template stored in a Git repository.

GetResourceSyncStatus (new)

Link ¶

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',
        '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',
            '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',
            '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',
            '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',
            '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.

CreateRepositoryLink (new)

Link ¶

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',
        '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.

GetSyncBlockerSummary (new)

Link ¶

Returns a list of the most recent sync blockers.

See also: AWS API Documentation

Request Syntax

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

type SyncType:

string

param SyncType:

[REQUIRED]

The sync type for the sync blocker summary.

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'SyncBlockerSummary': {
        'ResourceName': 'string',
        'ParentResourceName': 'string',
        'LatestBlockers': [
            {
                'Id': 'string',
                'Type': 'AUTOMATED',
                'Status': 'ACTIVE'|'RESOLVED',
                'CreatedReason': 'string',
                'CreatedAt': datetime(2015, 1, 1),
                'Contexts': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'ResolvedReason': 'string',
                'ResolvedAt': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

(dict) --
- SyncBlockerSummary (dict) --
  
  The list of sync blockers for a specified resource.
  - ResourceName (string) --
    
    The resource name for sync blocker summary.
  - ParentResourceName (string) --
    
    The parent resource name for a sync blocker summary.
  - LatestBlockers (list) --
    
    The latest events for a sync blocker summary.
    - (dict) --
      
      Information about a blocker for a sync event.
      - Id (string) --
        
        The ID for a specific sync blocker.
      - Type (string) --
        
        The sync blocker type.
      - Status (string) --
        
        The status for a specific sync blocker.
      - CreatedReason (string) --
        
        The provided reason for a specific sync blocker.
      - CreatedAt (datetime) --
        
        The creation time for a specific sync blocker.
      - Contexts (list) --
        
        The contexts for a specific sync blocker.
        
        (dict) --
        
        The context for a specific sync blocker.
        
        Key (string) --
        
        The key provided for a context key-value pair for a specific sync blocker.
        
        Value (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 (datetime) --
        
        The time that a specific sync blocker was resolved.

ListRepositoryLinks (new)

Link ¶

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',
            '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.

DeleteRepositoryLink (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_repository_link(
    RepositoryLinkId='string'
)

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

The ID of the repository link to be deleted.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetRepositoryLink (new)

Link ¶

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',
        '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.

GetRepositorySyncStatus (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_repository_sync_status(
    Branch='string',
    RepositoryLinkId='string',
    SyncType='CFN_STACK_SYNC'
)

type Branch:

string

param Branch:

[REQUIRED]

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

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

The repository link ID for the requested repository sync status.

type SyncType:

string

param SyncType:

[REQUIRED]

The sync type of the requested sync status.

rtype:

dict

returns:

Response Syntax

{
    'LatestSync': {
        'StartedAt': datetime(2015, 1, 1),
        'Status': 'FAILED'|'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'QUEUED',
        'Events': [
            {
                'Event': 'string',
                'ExternalId': 'string',
                'Time': datetime(2015, 1, 1),
                'Type': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- LatestSync (dict) --
  
  The status of the latest sync returned for a specified repository and branch.
  - StartedAt (datetime) --
    
    The start time of a specific sync attempt.
  - Status (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.
  - Events (list) --
    
    The events associated with a specific sync attempt.
    - (dict) --
      
      Information about a repository sync event.
      - Event (string) --
        
        A description of a repository sync event.
      - ExternalId (string) --
        
        The ID for a repository sync event.
      - Time (datetime) --
        
        The time that a repository sync event occurred.
      - Type (string) --
        
        The event type for a repository sync event.

GetSyncConfiguration (new)

Link ¶

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',
        '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.

ListSyncConfigurations (new)

Link ¶

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',
            '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.

CreateSyncConfiguration (new)

Link ¶

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',
        '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.

UpdateSyncBlocker (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_sync_blocker(
    Id='string',
    SyncType='CFN_STACK_SYNC',
    ResourceName='string',
    ResolvedReason='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the sync blocker to be updated.

type SyncType:

string

param SyncType:

[REQUIRED]

The sync type of the sync blocker to be updated.

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

type ResolvedReason:

string

param ResolvedReason:

[REQUIRED]

The reason for resolving the sync blocker.

rtype:

dict

returns:

Response Syntax

{
    'ResourceName': 'string',
    'ParentResourceName': 'string',
    'SyncBlocker': {
        'Id': 'string',
        'Type': 'AUTOMATED',
        'Status': 'ACTIVE'|'RESOLVED',
        'CreatedReason': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'Contexts': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ResolvedReason': 'string',
        'ResolvedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- ResourceName (string) --
  
  The resource name for the sync blocker.
- ParentResourceName (string) --
  
  The parent resource name for the sync blocker.
- SyncBlocker (dict) --
  
  Information about the sync blocker to be updated.
  - Id (string) --
    
    The ID for a specific sync blocker.
  - Type (string) --
    
    The sync blocker type.
  - Status (string) --
    
    The status for a specific sync blocker.
  - CreatedReason (string) --
    
    The provided reason for a specific sync blocker.
  - CreatedAt (datetime) --
    
    The creation time for a specific sync blocker.
  - Contexts (list) --
    
    The contexts for a specific sync blocker.
    - (dict) --
      
      The context for a specific sync blocker.
      - Key (string) --
        
        The key provided for a context key-value pair for a specific sync blocker.
      - Value (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 (datetime) --
    
    The time that a specific sync blocker was resolved.

DeleteSyncConfiguration (new)

Link ¶

Deletes the sync configuration for a specified repository and connection.

See also: AWS API Documentation

Request Syntax

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

type SyncType:

string

param SyncType:

[REQUIRED]

The type of sync configuration to be deleted.

type ResourceName:

string

param ResourceName:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

UpdateSyncConfiguration (new)

Link ¶

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',
        '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.

ListRepositorySyncDefinitions (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_repository_sync_definitions(
    RepositoryLinkId='string',
    SyncType='CFN_STACK_SYNC'
)

type RepositoryLinkId:

string

param RepositoryLinkId:

[REQUIRED]

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

type SyncType:

string

param SyncType:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'RepositorySyncDefinitions': [
        {
            'Branch': 'string',
            'Directory': 'string',
            'Parent': 'string',
            'Target': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RepositorySyncDefinitions (list) --
  
  The list of repository sync definitions returned by the request. A RepositorySyncDefinition is a mapping from a repository branch to all the Amazon Web Services resources that are being synced from that branch.
  - (dict) --
    
    The definition for a repository with a sync configuration.
    - Branch (string) --
      
      The branch specified for a repository sync definition.
    - Directory (string) --
      
      The configuration file for a repository sync definition. This value comes from creating or updating the config-file field of a sync-configuration.
    - Parent (string) --
      
      The parent resource specified for a repository sync definition.
    - Target (string) --
      
      The target resource specified for a repository sync definition. In some cases, such as CFN_STACK_SYNC, the parent and target resource are the same.
- NextToken (string) --
  
  An enumeration token that, when provided in a request, returns the next batch of the results.

UpdateRepositoryLink (new)

Link ¶

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',
        '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.