You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeCommit::Types::CreatePullRequestInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreatePullRequestInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  title: "Title", # required
  description: "Description",
  targets: [ # required
    {
      repository_name: "RepositoryName", # required
      source_reference: "ReferenceName", # required
      destination_reference: "ReferenceName",
    },
  ],
  client_request_token: "ClientRequestToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.

Returns:

  • (String)

    A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter.

#descriptionString

A description of the pull request.

Returns:

  • (String)

    A description of the pull request.

#targetsArray<Types::Target>

The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

Returns:

  • (Array<Types::Target>)

    The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

#titleString

The title of the pull request. This title will be used to identify the pull request to other users in the repository.

Returns:

  • (String)

    The title of the pull request.