[ aws . codebuild ]

list-source-credentials

Description

Returns a list of SourceCredentialsInfo objects.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-source-credentials
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To view a list of sourceCredentialsObjects

The following list-source-credentials example lists tokens for an AWS account connected to one Bitbucket account and one GitHub account. Each sourceCredentialsInfos object in the response contains connected source credentials information.

aws codebuild list-source-credentials

Output:

{
    "sourceCredentialsInfos": [
        {
            "serverType": "BITBUCKET",
            "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket",
            "authType": "BASIC_AUTH"
        },
        {
            "serverType": "GITHUB",
            "arn": "arn:aws:codebuild:us-west-2:123456789012:token/github",
            "authType": "OAUTH"
        }
    ]
}

For more information, see Connect Source Providers with Access Tokens (CLI) in the AWS CodeBuild User Guide.

Output

sourceCredentialsInfos -> (list)

A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

(structure)

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

arn -> (string)

The Amazon Resource Name (ARN) of the token.

serverType -> (string)

The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

authType -> (string)

The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.