AWS CodeStar connections

2020/05/06 - AWS CodeStar connections - 3 new1 updated api methods

Changes  Update codestar-connections client to latest version

TagResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

type Tags:

list

param Tags:

[REQUIRED]

The tags you want to modify or add 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 AWS services that support tags.

    • Key (string) -- [REQUIRED]

      The tag's key.

    • Value (string) -- [REQUIRED]

      The tag's value.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Removes tags from an AWS resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

type TagKeys:

list

param TagKeys:

[REQUIRED]

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

ListTagsForResource (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)
type ResourceArn:

string

param ResourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

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

Response Structure

  • (dict) --

    • Tags (list) --

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

      • (dict) --

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

        This tag is available for use by AWS services that support tags.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.

CreateConnection (updated) Link ¶
Changes (both)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a connection that can then be given to other AWS 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',
    ConnectionName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ProviderType:

string

param ProviderType:

[REQUIRED]

The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.

type ConnectionName:

string

param ConnectionName:

[REQUIRED]

The name of the connection to be created. The name must be unique in the calling AWS account.

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 AWS services that support tags.

    • Key (string) -- [REQUIRED]

      The tag's key.

    • Value (string) -- [REQUIRED]

      The tag's value.

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 AWS services.

    • 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 AWS services that support tags.

        • Key (string) --

          The tag's key.

        • Value (string) --

          The tag's value.