| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CodeCommit.GetDifferences
Description
Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference). Results can be limited to a specified path.
This operation returns paginated results.
Synopsis
- data GetDifferences = GetDifferences' {}
- newGetDifferences :: Text -> Text -> GetDifferences
- getDifferences_maxResults :: Lens' GetDifferences (Maybe Int)
- getDifferences_nextToken :: Lens' GetDifferences (Maybe Text)
- getDifferences_afterPath :: Lens' GetDifferences (Maybe Text)
- getDifferences_beforeCommitSpecifier :: Lens' GetDifferences (Maybe Text)
- getDifferences_beforePath :: Lens' GetDifferences (Maybe Text)
- getDifferences_repositoryName :: Lens' GetDifferences Text
- getDifferences_afterCommitSpecifier :: Lens' GetDifferences Text
- data GetDifferencesResponse = GetDifferencesResponse' {
- nextToken :: Maybe Text
- differences :: Maybe [Difference]
- httpStatus :: Int
- newGetDifferencesResponse :: Int -> GetDifferencesResponse
- getDifferencesResponse_nextToken :: Lens' GetDifferencesResponse (Maybe Text)
- getDifferencesResponse_differences :: Lens' GetDifferencesResponse (Maybe [Difference])
- getDifferencesResponse_httpStatus :: Lens' GetDifferencesResponse Int
Creating a Request
data GetDifferences Source #
See: newGetDifferences smart constructor.
Constructors
| GetDifferences' | |
Fields
| |
Instances
Create a value of GetDifferences with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetDifferences', getDifferences_maxResults - A non-zero, non-negative integer used to limit the number of returned
results.
GetDifferences, getDifferences_nextToken - An enumeration token that, when provided in a request, returns the next
batch of the results.
$sel:afterPath:GetDifferences', getDifferences_afterPath - The file path in which to check differences. Limits the results to this
path. Can also be used to specify the changed name of a directory or
folder, if it has changed. If not specified, differences are shown for
all paths.
$sel:beforeCommitSpecifier:GetDifferences', getDifferences_beforeCommitSpecifier - The branch, tag, HEAD, or other fully qualified reference used to
identify a commit (for example, the full commit ID). Optional. If not
specified, all changes before the afterCommitSpecifier value are
shown. If you do not use beforeCommitSpecifier in your request,
consider limiting the results with maxResults.
$sel:beforePath:GetDifferences', getDifferences_beforePath - The file path in which to check for differences. Limits the results to
this path. Can also be used to specify the previous name of a directory
or folder. If beforePath and afterPath are not specified,
differences are shown for all paths.
GetDifferences, getDifferences_repositoryName - The name of the repository where you want to get differences.
$sel:afterCommitSpecifier:GetDifferences', getDifferences_afterCommitSpecifier - The branch, tag, HEAD, or other fully qualified reference used to
identify a commit.
Request Lenses
getDifferences_maxResults :: Lens' GetDifferences (Maybe Int) Source #
A non-zero, non-negative integer used to limit the number of returned results.
getDifferences_nextToken :: Lens' GetDifferences (Maybe Text) Source #
An enumeration token that, when provided in a request, returns the next batch of the results.
getDifferences_afterPath :: Lens' GetDifferences (Maybe Text) Source #
The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences are shown for all paths.
getDifferences_beforeCommitSpecifier :: Lens' GetDifferences (Maybe Text) Source #
The branch, tag, HEAD, or other fully qualified reference used to
identify a commit (for example, the full commit ID). Optional. If not
specified, all changes before the afterCommitSpecifier value are
shown. If you do not use beforeCommitSpecifier in your request,
consider limiting the results with maxResults.
getDifferences_beforePath :: Lens' GetDifferences (Maybe Text) Source #
The file path in which to check for differences. Limits the results to
this path. Can also be used to specify the previous name of a directory
or folder. If beforePath and afterPath are not specified,
differences are shown for all paths.
getDifferences_repositoryName :: Lens' GetDifferences Text Source #
The name of the repository where you want to get differences.
getDifferences_afterCommitSpecifier :: Lens' GetDifferences Text Source #
The branch, tag, HEAD, or other fully qualified reference used to identify a commit.
Destructuring the Response
data GetDifferencesResponse Source #
See: newGetDifferencesResponse smart constructor.
Constructors
| GetDifferencesResponse' | |
Fields
| |
Instances
newGetDifferencesResponse Source #
Create a value of GetDifferencesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDifferences, getDifferencesResponse_nextToken - An enumeration token that can be used in a request to return the next
batch of the results.
$sel:differences:GetDifferencesResponse', getDifferencesResponse_differences - A data type object that contains information about the differences,
including whether the difference is added, modified, or deleted (A, D,
M).
$sel:httpStatus:GetDifferencesResponse', getDifferencesResponse_httpStatus - The response's http status code.
Response Lenses
getDifferencesResponse_nextToken :: Lens' GetDifferencesResponse (Maybe Text) Source #
An enumeration token that can be used in a request to return the next batch of the results.
getDifferencesResponse_differences :: Lens' GetDifferencesResponse (Maybe [Difference]) Source #
A data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).
getDifferencesResponse_httpStatus :: Lens' GetDifferencesResponse Int Source #
The response's http status code.