Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeCommit.GetDifferences

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- afterPath :: Maybe Text
- nextToken :: Maybe Text
- beforeCommitSpecifier :: Maybe Text
- beforePath :: Maybe Text
- maxResults :: Maybe Int
- repositoryName :: Text
- afterCommitSpecifier :: Text
}
newGetDifferences :: Text -> Text -> GetDifferences
getDifferences_afterPath :: Lens' GetDifferences (Maybe Text)
getDifferences_nextToken :: Lens' GetDifferences (Maybe Text)
getDifferences_beforeCommitSpecifier :: Lens' GetDifferences (Maybe Text)
getDifferences_beforePath :: Lens' GetDifferences (Maybe Text)
getDifferences_maxResults :: Lens' GetDifferences (Maybe Int)
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

afterPath :: Maybe Text
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.
nextToken :: Maybe Text
An enumeration token that, when provided in a request, returns the next batch of the results.
beforeCommitSpecifier :: Maybe Text
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.
beforePath :: Maybe Text
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.
maxResults :: Maybe Int
A non-zero, non-negative integer used to limit the number of returned results.
repositoryName :: Text
The name of the repository where you want to get differences.
afterCommitSpecifier :: Text
The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

Instances

Instances details

Eq GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods (==) :: GetDifferences -> GetDifferences -> Bool # (/=) :: GetDifferences -> GetDifferences -> Bool #
Read GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods readsPrec :: Int -> ReadS GetDifferences # readList :: ReadS [GetDifferences] # readPrec :: ReadPrec GetDifferences # readListPrec :: ReadPrec [GetDifferences] #
Show GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods showsPrec :: Int -> GetDifferences -> ShowS # show :: GetDifferences -> String # showList :: [GetDifferences] -> ShowS #
Generic GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Associated Types type Rep GetDifferences :: Type -> Type # Methods from :: GetDifferences -> Rep GetDifferences x # to :: Rep GetDifferences x -> GetDifferences #
NFData GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods rnf :: GetDifferences -> () #
Hashable GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods hashWithSalt :: Int -> GetDifferences -> Int # hash :: GetDifferences -> Int #
ToJSON GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods toJSON :: GetDifferences -> Value # toEncoding :: GetDifferences -> Encoding # toJSONList :: [GetDifferences] -> Value # toEncodingList :: [GetDifferences] -> Encoding #
AWSPager GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods page :: GetDifferences -> AWSResponse GetDifferences -> Maybe GetDifferences #
AWSRequest GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Associated Types type AWSResponse GetDifferences # Methods request :: GetDifferences -> Request GetDifferences # response :: MonadResource m => Logger -> Service -> Proxy GetDifferences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDifferences))) #
ToHeaders GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods toHeaders :: GetDifferences -> [Header] #
ToPath GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods toPath :: GetDifferences -> ByteString #
ToQuery GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods toQuery :: GetDifferences -> QueryString #
type Rep GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences type Rep GetDifferences = D1 ('MetaData "GetDifferences" "Amazonka.CodeCommit.GetDifferences" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetDifferences'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "afterPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "beforeCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "beforePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "afterCommitSpecifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse GetDifferences Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences type AWSResponse GetDifferences = GetDifferencesResponse

newGetDifferences Source #

Arguments

:: Text	`$sel:repositoryName:GetDifferences'`
-> Text	`$sel:afterCommitSpecifier:GetDifferences'`
-> GetDifferences

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: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:nextToken:GetDifferences', getDifferences_nextToken - An enumeration token that, when provided in a request, returns the next batch of the results.

$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.

$sel:maxResults:GetDifferences', getDifferences_maxResults - A non-zero, non-negative integer used to limit the number of returned results.

$sel:repositoryName: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_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_nextToken :: Lens' GetDifferences (Maybe Text) Source #

An enumeration token that, when provided in a request, returns the next batch of the results.

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_maxResults :: Lens' GetDifferences (Maybe Int) Source #

A non-zero, non-negative integer used to limit the number of returned results.

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 nextToken :: Maybe Text An enumeration token that can be used in a request to return the next batch of the results. differences :: Maybe [Difference] A data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M). httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods (==) :: GetDifferencesResponse -> GetDifferencesResponse -> Bool # (/=) :: GetDifferencesResponse -> GetDifferencesResponse -> Bool #
Read GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods readsPrec :: Int -> ReadS GetDifferencesResponse # readList :: ReadS [GetDifferencesResponse] # readPrec :: ReadPrec GetDifferencesResponse # readListPrec :: ReadPrec [GetDifferencesResponse] #
Show GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods showsPrec :: Int -> GetDifferencesResponse -> ShowS # show :: GetDifferencesResponse -> String # showList :: [GetDifferencesResponse] -> ShowS #
Generic GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Associated Types type Rep GetDifferencesResponse :: Type -> Type # Methods from :: GetDifferencesResponse -> Rep GetDifferencesResponse x # to :: Rep GetDifferencesResponse x -> GetDifferencesResponse #
NFData GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences Methods rnf :: GetDifferencesResponse -> () #
type Rep GetDifferencesResponse Source #
Instance details Defined in Amazonka.CodeCommit.GetDifferences type Rep GetDifferencesResponse = D1 ('MetaData "GetDifferencesResponse" "Amazonka.CodeCommit.GetDifferences" "libZSservicesZSamazonka-codecommitZSamazonka-codecommit" 'False) (C1 ('MetaCons "GetDifferencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "differences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Difference])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDifferencesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDifferencesResponse'`
-> GetDifferencesResponse

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:

$sel:nextToken: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.