AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb

Overview

Note:

When making an API call, you may pass CreatePullRequestInput data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

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 returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1729

class CreatePullRequestInput < Struct.new(
  :title,
  :description,
  :targets,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the pull request.

Returns:

  • (String)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1729

class CreatePullRequestInput < Struct.new(
  :title,
  :description,
  :targets,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#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:



1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1729

class CreatePullRequestInput < Struct.new(
  :title,
  :description,
  :targets,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

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

Returns:

  • (String)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1729

class CreatePullRequestInput < Struct.new(
  :title,
  :description,
  :targets,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end