pub struct Client { /* private fields */ }
Expand description

Client for AWS CodeBuild

Client for invoking operations on AWS CodeBuild. Each operation on AWS CodeBuild is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_codebuild::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codebuild::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_codebuild::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the BatchDeleteBuilds operation.

Constructs a fluent builder for the BatchGetBuildBatches operation.

Constructs a fluent builder for the BatchGetBuilds operation.

Constructs a fluent builder for the BatchGetProjects operation.

Constructs a fluent builder for the BatchGetReportGroups operation.

Constructs a fluent builder for the BatchGetReports operation.

Constructs a fluent builder for the CreateProject operation.

Constructs a fluent builder for the CreateReportGroup operation.

Constructs a fluent builder for the CreateWebhook operation.

Constructs a fluent builder for the DeleteBuildBatch operation.

Constructs a fluent builder for the DeleteProject operation.

Constructs a fluent builder for the DeleteReport operation.

Constructs a fluent builder for the DeleteReportGroup operation.

Constructs a fluent builder for the DeleteResourcePolicy operation.

Constructs a fluent builder for the DeleteSourceCredentials operation.

Constructs a fluent builder for the DeleteWebhook operation.

Constructs a fluent builder for the DescribeCodeCoverages operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeTestCases operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
  • On success, responds with DescribeTestCasesOutput with field(s):
    • next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • test_cases(Option<Vec<TestCase>>):

      The returned list of test cases.

  • On failure, responds with SdkError<DescribeTestCasesError>

Constructs a fluent builder for the GetReportGroupTrend operation.

Constructs a fluent builder for the GetResourcePolicy operation.

Constructs a fluent builder for the ImportSourceCredentials operation.

Constructs a fluent builder for the InvalidateProjectCache operation.

Constructs a fluent builder for the ListBuildBatches operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBuildBatchesForProject operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListBuilds operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      The order to list build IDs. Valid values include:

      • ASCENDING: List the build IDs in ascending order by build ID.

      • DESCENDING: List the build IDs in descending order by build ID.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • On success, responds with ListBuildsOutput with field(s):
    • ids(Option<Vec<String>>):

      A list of build IDs, with each build ID representing a single build.

    • next_token(Option<String>):

      If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

  • On failure, responds with SdkError<ListBuildsError>

Constructs a fluent builder for the ListBuildsForProject operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • project_name(impl Into<String>) / set_project_name(Option<String>):

      The name of the CodeBuild project.

    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

      Valid values include:

      • ASCENDING: List the build identifiers in ascending order, by build number.

      • DESCENDING: List the build identifiers in descending order, by build number.

      If the project has more than 100 builds, setting the sort order will result in an error.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • On success, responds with ListBuildsForProjectOutput with field(s):
    • ids(Option<Vec<String>>):

      A list of build identifiers for the specified build project, with each build ID representing a single build.

    • next_token(Option<String>):

      If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

  • On failure, responds with SdkError<ListBuildsForProjectError>

Constructs a fluent builder for the ListCuratedEnvironmentImages operation.

Constructs a fluent builder for the ListProjects operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_by(ProjectSortByType) / set_sort_by(Option<ProjectSortByType>):

      The criterion to be used to list build project names. Valid values include:

      • CREATED_TIME: List based on when each build project was created.

      • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.

      • NAME: List based on each build project’s name.

      Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      The order in which to list build projects. Valid values include:

      • ASCENDING: List in ascending order.

      • DESCENDING: List in descending order.

      Use sortBy to specify the criterion to be used to list build project names.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • On success, responds with ListProjectsOutput with field(s):
    • next_token(Option<String>):

      If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

    • projects(Option<Vec<String>>):

      The list of build project names, with each build project name representing a single build project.

  • On failure, responds with SdkError<ListProjectsError>

Constructs a fluent builder for the ListReportGroups operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

    • sort_by(ReportGroupSortByType) / set_sort_by(Option<ReportGroupSortByType>):

      The criterion to be used to list build report groups. Valid values include:

      • CREATED_TIME: List based on when each report group was created.

      • LAST_MODIFIED_TIME: List based on when each report group was last changed.

      • NAME: List based on each report group’s name.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

  • On success, responds with ListReportGroupsOutput with field(s):
    • next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • report_groups(Option<Vec<String>>):

      The list of ARNs for the report groups in the current Amazon Web Services account.

  • On failure, responds with SdkError<ListReportGroupsError>

Constructs a fluent builder for the ListReports operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      Specifies the sort order for the list of returned reports. Valid values are:

      • ASCENDING: return reports in chronological order based on their creation date.

      • DESCENDING: return reports in the reverse chronological order based on their creation date.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

    • filter(ReportFilter) / set_filter(Option<ReportFilter>):

      A ReportFilter object used to filter the returned reports.

  • On success, responds with ListReportsOutput with field(s):
    • next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • reports(Option<Vec<String>>):

      The list of returned ARNs for the reports in the current Amazon Web Services account.

  • On failure, responds with SdkError<ListReportsError>

Constructs a fluent builder for the ListReportsForReportGroup operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListSharedProjects operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_by(SharedResourceSortByType) / set_sort_by(Option<SharedResourceSortByType>):

      The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

      • ARN: List based on the ARN.

      • MODIFIED_TIME: List based on when information about the shared project was last changed.

    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      The order in which to list shared build projects. Valid values include:

      • ASCENDING: List in ascending order.

      • DESCENDING: List in descending order.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • On success, responds with ListSharedProjectsOutput with field(s):
    • next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • projects(Option<Vec<String>>):

      The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

  • On failure, responds with SdkError<ListSharedProjectsError>

Constructs a fluent builder for the ListSharedReportGroups operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • sort_order(SortOrderType) / set_sort_order(Option<SortOrderType>):

      The order in which to list shared report groups. Valid values include:

      • ASCENDING: List in ascending order.

      • DESCENDING: List in descending order.

    • sort_by(SharedResourceSortByType) / set_sort_by(Option<SharedResourceSortByType>):

      The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:

      • ARN: List based on the ARN.

      • MODIFIED_TIME: List based on when information about the shared report group was last changed.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

  • On success, responds with ListSharedReportGroupsOutput with field(s):
    • next_token(Option<String>):

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • report_groups(Option<Vec<String>>):

      The list of ARNs for the report groups shared with the current Amazon Web Services account or user.

  • On failure, responds with SdkError<ListSharedReportGroupsError>

Constructs a fluent builder for the ListSourceCredentials operation.

Constructs a fluent builder for the PutResourcePolicy operation.

Constructs a fluent builder for the RetryBuild operation.

Constructs a fluent builder for the RetryBuildBatch operation.

Constructs a fluent builder for the StartBuild operation.

Constructs a fluent builder for the StartBuildBatch operation.

Constructs a fluent builder for the StopBuild operation.

Constructs a fluent builder for the StopBuildBatch operation.

Constructs a fluent builder for the UpdateProject operation.

Constructs a fluent builder for the UpdateProjectVisibility operation.

Constructs a fluent builder for the UpdateReportGroup operation.

Constructs a fluent builder for the UpdateWebhook operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more