Struct aws_sdk_codecatalyst::client::Client

pub struct Client { /* private fields */ }

Client for Amazon CodeCatalyst

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

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_codecatalyst::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_codecatalyst::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the GetUserDetails operation has a Client::get_user_details, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.get_user_details()
    .id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_access_token(&self) -> CreateAccessTokenFluentBuilder

Constructs a fluent builder for the CreateAccessToken operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The friendly name of the personal access token.

    
    
  • expires_time(DateTime) / set_expires_time(Option<DateTime>):
    required: false
    

    The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    
    
• On success, responds with CreateAccessTokenOutput with field(s):
  • secret(String):

    The secret value of the personal access token.

  • name(String):

    The friendly name of the personal access token.

  • expires_time(DateTime):

    The date and time the personal access token expires, in coordinated universal time (UTC) timestamp format as specified in RFC 3339. If not specified, the default is one year from creation.

  • access_token_id(String):

    The system-generated unique ID of the access token.

• On failure, responds with SdkError<CreateAccessTokenError>

impl Client

pub fn create_dev_environment(&self) -> CreateDevEnvironmentFluentBuilder

Constructs a fluent builder for the CreateDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • repositories(RepositoryInput) / set_repositories(Option<Vec::<RepositoryInput>>):
    required: false
    

    The source repository that contains the branch to clone into the Dev Environment.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: false
    

    The user-defined alias for a Dev Environment.

    
    
  • ides(IdeConfiguration) / set_ides(Option<Vec::<IdeConfiguration>>):
    required: false
    

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    An IDE is required to create a Dev Environment. For Dev Environment creation, this field contains configuration information and must be provided.

    
    
  • instance_type(InstanceType) / set_instance_type(Option<InstanceType>):
    required: true
    

    The Amazon EC2 instace type to use for the Dev Environment.

    
    
  • inactivity_timeout_minutes(i32) / set_inactivity_timeout_minutes(Option<i32>):
    required: false
    

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

    
    
  • persistent_storage(PersistentStorageConfiguration) / set_persistent_storage(Option<PersistentStorageConfiguration>):
    required: true
    

    Information about the amount of storage allocated to the Dev Environment.

    By default, a Dev Environment is configured to have 16GB of persistent storage when created from the Amazon CodeCatalyst console, but there is no default when programmatically creating a Dev Environment. Valid values for persistent storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

    
    
  • vpc_connection_name(impl Into<String>) / set_vpc_connection_name(Option<String>):
    required: false
    

    The name of the connection that will be used to connect to Amazon VPC, if any.

    
    
• On success, responds with CreateDevEnvironmentOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

  • vpc_connection_name(Option<String>):

    The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

• On failure, responds with SdkError<CreateDevEnvironmentError>

impl Client

pub fn create_project(&self) -> CreateProjectFluentBuilder

Constructs a fluent builder for the CreateProject operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    The friendly name of the project that will be displayed to users.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose.

    
    
• On success, responds with CreateProjectOutput with field(s):
  • space_name(Option<String>):

    The name of the space.

  • name(String):

    The name of the project in the space.

  • display_name(Option<String>):

    The friendly name of the project.

  • description(Option<String>):

    The description of the project.

• On failure, responds with SdkError<CreateProjectError>

impl Client

pub fn create_source_repository(&self) -> CreateSourceRepositoryFluentBuilder

Constructs a fluent builder for the CreateSourceRepository operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the source repository. For more information about name requirements, see Quotas for source repositories.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the source repository.

    
    
• On success, responds with CreateSourceRepositoryOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • name(String):

    The name of the source repository.

  • description(Option<String>):

    The description of the source repository.

• On failure, responds with SdkError<CreateSourceRepositoryError>

impl Client

pub fn create_source_repository_branch( &self ) -> CreateSourceRepositoryBranchFluentBuilder

Constructs a fluent builder for the CreateSourceRepositoryBranch operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • source_repository_name(impl Into<String>) / set_source_repository_name(Option<String>):
    required: true
    

    The name of the repository where you want to create a branch.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the branch you’re creating.

    
    
  • head_commit_id(impl Into<String>) / set_head_commit_id(Option<String>):
    required: false
    

    The commit ID in an existing branch from which you want to create the new branch.

    
    
• On success, responds with CreateSourceRepositoryBranchOutput with field(s):
  • r#ref(Option<String>):

    The Git reference name of the branch.

  • name(Option<String>):

    The name of the newly created branch.

  • last_updated_time(Option<DateTime>):

    The time the branch was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • head_commit_id(Option<String>):

    The commit ID of the tip of the newly created branch.

• On failure, responds with SdkError<CreateSourceRepositoryBranchError>

impl Client

pub fn delete_access_token(&self) -> DeleteAccessTokenFluentBuilder

Constructs a fluent builder for the DeleteAccessToken operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the personal access token to delete. You can find the IDs of all PATs associated with your Amazon Web Services Builder ID in a space by calling ListAccessTokens.

    
    
• On success, responds with DeleteAccessTokenOutput
• On failure, responds with SdkError<DeleteAccessTokenError>

impl Client

pub fn delete_dev_environment(&self) -> DeleteDevEnvironmentFluentBuilder

Constructs a fluent builder for the DeleteDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment you want to delete. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

    
    
• On success, responds with DeleteDevEnvironmentOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the deleted Dev Environment.

• On failure, responds with SdkError<DeleteDevEnvironmentError>

impl Client

pub fn delete_project(&self) -> DeleteProjectFluentBuilder

Constructs a fluent builder for the DeleteProject operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the project in the space. To retrieve a list of project names, use ListProjects.

    
    
• On success, responds with DeleteProjectOutput with field(s):
  • space_name(String):

    The name of the space.

  • name(String):

    The name of the project in the space.

  • display_name(Option<String>):

    The friendly name displayed to users of the project in Amazon CodeCatalyst.

• On failure, responds with SdkError<DeleteProjectError>

impl Client

pub fn delete_source_repository(&self) -> DeleteSourceRepositoryFluentBuilder

Constructs a fluent builder for the DeleteSourceRepository operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the source repository.

    
    
• On success, responds with DeleteSourceRepositoryOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • name(String):

    The name of the repository.

• On failure, responds with SdkError<DeleteSourceRepositoryError>

impl Client

pub fn delete_space(&self) -> DeleteSpaceFluentBuilder

Constructs a fluent builder for the DeleteSpace operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the space. To retrieve a list of space names, use ListSpaces.

    
    
• On success, responds with DeleteSpaceOutput with field(s):
  • name(String):

    The name of the space.

  • display_name(Option<String>):

    The friendly name of the space displayed to users of the space in Amazon CodeCatalyst.

• On failure, responds with SdkError<DeleteSpaceError>

impl Client

pub fn get_dev_environment(&self) -> GetDevEnvironmentFluentBuilder

Constructs a fluent builder for the GetDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments.

    
    
• On success, responds with GetDevEnvironmentOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

  • last_updated_time(DateTime):

    The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • creator_id(String):

    The system-generated unique ID of the user who created the Dev Environment.

  • status(DevEnvironmentStatus):

    The current status of the Dev Environment.

  • status_reason(Option<String>):

    The reason for the status.

  • repositories(Vec::<DevEnvironmentRepositorySummary>):

    The source repository that contains the branch cloned into the Dev Environment.

  • alias(Option<String>):

    The user-specified alias for the Dev Environment.

  • ides(Option<Vec::<Ide>>):

    Information about the integrated development environment (IDE) configured for the Dev Environment.

  • instance_type(InstanceType):

    The Amazon EC2 instace type to use for the Dev Environment.

  • inactivity_timeout_minutes(i32):

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

  • persistent_storage(Option<PersistentStorage>):

    Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

  • vpc_connection_name(Option<String>):

    The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.

• On failure, responds with SdkError<GetDevEnvironmentError>

impl Client

pub fn get_project(&self) -> GetProjectFluentBuilder

Constructs a fluent builder for the GetProject operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
• On success, responds with GetProjectOutput with field(s):
  • space_name(Option<String>):

    The name of the space.

  • name(String):

    The name of the project in the space.

  • display_name(Option<String>):

    The friendly name of the project displayed to users in Amazon CodeCatalyst.

  • description(Option<String>):

    The description of the project.

• On failure, responds with SdkError<GetProjectError>

impl Client

pub fn get_source_repository(&self) -> GetSourceRepositoryFluentBuilder

Constructs a fluent builder for the GetSourceRepository operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the source repository.

    
    
• On success, responds with GetSourceRepositoryOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • name(String):

    The name of the source repository.

  • description(Option<String>):

    The description of the source repository.

  • last_updated_time(DateTime):

    The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • created_time(DateTime):

    The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

• On failure, responds with SdkError<GetSourceRepositoryError>

impl Client

pub fn get_source_repository_clone_urls( &self ) -> GetSourceRepositoryCloneUrlsFluentBuilder

Constructs a fluent builder for the GetSourceRepositoryCloneUrls operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • source_repository_name(impl Into<String>) / set_source_repository_name(Option<String>):
    required: true
    

    The name of the source repository.

    
    
• On success, responds with GetSourceRepositoryCloneUrlsOutput with field(s):
  • https(String):

    The HTTPS URL to use when cloning the source repository.

• On failure, responds with SdkError<GetSourceRepositoryCloneUrlsError>

impl Client

pub fn get_space(&self) -> GetSpaceFluentBuilder

Constructs a fluent builder for the GetSpace operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the space.

    
    
• On success, responds with GetSpaceOutput with field(s):
  • name(String):

    The name of the space.

  • region_name(String):

    The Amazon Web Services Region where the space exists.

  • display_name(Option<String>):

    The friendly name of the space displayed to users.

  • description(Option<String>):

    The description of the space.

• On failure, responds with SdkError<GetSpaceError>

impl Client

pub fn get_subscription(&self) -> GetSubscriptionFluentBuilder

Constructs a fluent builder for the GetSubscription operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
• On success, responds with GetSubscriptionOutput with field(s):
  • subscription_type(Option<String>):

    The type of the billing plan for the space.

  • aws_account_name(Option<String>):

    The display name of the Amazon Web Services account used for billing for the space.

  • pending_subscription_type(Option<String>):

    The type of the billing plan that the space will be changed to at the start of the next billing cycle. This applies only to changes that reduce the functionality available for the space. Billing plan changes that increase functionality are applied immediately. For more information, see Pricing.

  • pending_subscription_start_time(Option<DateTime>):

    The day and time the pending change will be applied to the space, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

• On failure, responds with SdkError<GetSubscriptionError>

impl Client

pub fn get_user_details(&self) -> GetUserDetailsFluentBuilder

Constructs a fluent builder for the GetUserDetails operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: false
    

    The system-generated unique ID of the user.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    The name of the user as displayed in Amazon CodeCatalyst.

    
    
• On success, responds with GetUserDetailsOutput with field(s):
  • user_id(Option<String>):

    The system-generated unique ID of the user.

  • user_name(Option<String>):

    The name of the user as displayed in Amazon CodeCatalyst.

  • display_name(Option<String>):

    The friendly name displayed for the user in Amazon CodeCatalyst.

  • primary_email(Option<EmailAddress>):

    The email address provided by the user when they signed up.

  • version(Option<String>):

• On failure, responds with SdkError<GetUserDetailsError>

impl Client

pub fn get_workflow(&self) -> GetWorkflowFluentBuilder

Constructs a fluent builder for the GetWorkflow operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the workflow. To rerieve a list of workflow IDs, use ListWorkflows.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
• On success, responds with GetWorkflowOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The ID of the workflow.

  • name(String):

    The name of the workflow.

  • source_repository_name(Option<String>):

    The name of the source repository where the workflow YAML is stored.

  • source_branch_name(Option<String>):

    The name of the branch that contains the workflow YAML.

  • definition(Option<WorkflowDefinition>):

    Information about the workflow definition file for the workflow.

  • created_time(DateTime):

    The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

  • last_updated_time(DateTime):

    The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

  • run_mode(WorkflowRunMode):

    The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

  • status(WorkflowStatus):

    The status of the workflow.

• On failure, responds with SdkError<GetWorkflowError>

impl Client

pub fn get_workflow_run(&self) -> GetWorkflowRunFluentBuilder

Constructs a fluent builder for the GetWorkflowRun operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the workflow run. To retrieve a list of workflow run IDs, use ListWorkflowRuns.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
• On success, responds with GetWorkflowRunOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The ID of the workflow run.

  • workflow_id(String):

    The ID of the workflow.

  • status(WorkflowRunStatus):

    The status of the workflow run.

  • status_reasons(Option<Vec::<WorkflowRunStatusReason>>):

    Information about the reasons for the status of the workflow run.

  • start_time(DateTime):

    The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

  • end_time(Option<DateTime>):

    The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

  • last_updated_time(DateTime):

    The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

• On failure, responds with SdkError<GetWorkflowRunError>

impl Client

pub fn list_access_tokens(&self) -> ListAccessTokensFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

    
    
• On success, responds with ListAccessTokensOutput with field(s):
  • items(Vec::<AccessTokenSummary>):

    A list of personal access tokens (PATs) associated with the calling user identity.

  • next_token(Option<String>):

    A token returned from a call to this API to indicate the next batch of results to return, if any.

• On failure, responds with SdkError<ListAccessTokensError>

impl Client

pub fn list_dev_environment_sessions( &self ) -> ListDevEnvironmentSessionsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • dev_environment_id(impl Into<String>) / set_dev_environment_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListDevEnvironmentSessionsOutput with field(s):
  • items(Vec::<DevEnvironmentSessionSummary>):

    Information about each session retrieved in the list.

  • next_token(Option<String>):

    A token returned from a call to this API to indicate the next batch of results to return, if any.

• On failure, responds with SdkError<ListDevEnvironmentSessionsError>

impl Client

pub fn list_dev_environments(&self) -> ListDevEnvironmentsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: false
    

    The name of the project in the space.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Information about filters to apply to narrow the results returned in the list.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListDevEnvironmentsOutput with field(s):
  • items(Vec::<DevEnvironmentSummary>):

    Information about the Dev Environments in a project.

  • next_token(Option<String>):

    A token returned from a call to this API to indicate the next batch of results to return, if any.

• On failure, responds with SdkError<ListDevEnvironmentsError>

impl Client

pub fn list_event_logs(&self) -> ListEventLogsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The date and time when you want to start retrieving events, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The time after which you do not want any events retrieved, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    
    
  • event_name(impl Into<String>) / set_event_name(Option<String>):
    required: false
    

    The name of the event.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Vec::<EventLogEntry>):

    Information about each event retrieved in the list.

• On failure, responds with SdkError<ListEventLogsError>

impl Client

pub fn list_projects(&self) -> ListProjectsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
  • filters(ProjectListFilter) / set_filters(Option<Vec::<ProjectListFilter>>):
    required: false
    

    Information about filters to apply to narrow the results returned in the list.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Option<Vec::<ProjectSummary>>):

    Information about the projects.

• On failure, responds with SdkError<ListProjectsError>

impl Client

pub fn list_source_repositories(&self) -> ListSourceRepositoriesFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
• On success, responds with ListSourceRepositoriesOutput with field(s):
  • items(Option<Vec::<ListSourceRepositoriesItem>>):

    Information about the source repositories.

  • next_token(Option<String>):

    A token returned from a call to this API to indicate the next batch of results to return, if any.

• On failure, responds with SdkError<ListSourceRepositoriesError>

impl Client

pub fn list_source_repository_branches( &self ) -> ListSourceRepositoryBranchesFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • source_repository_name(impl Into<String>) / set_source_repository_name(Option<String>):
    required: true
    

    The name of the source repository.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Vec::<ListSourceRepositoryBranchesItem>):

    Information about the source branches.

• On failure, responds with SdkError<ListSourceRepositoryBranchesError>

impl Client

pub fn list_spaces(&self) -> ListSpacesFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Option<Vec::<SpaceSummary>>):

    Information about the spaces.

• On failure, responds with SdkError<ListSpacesError>

impl Client

pub fn list_workflow_runs(&self) -> ListWorkflowRunsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: false
    

    The ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
  • sort_by(WorkflowRunSortCriteria) / set_sort_by(Option<Vec::<WorkflowRunSortCriteria>>):
    required: false
    

    Information used to sort the items in the returned list.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Option<Vec::<WorkflowRunSummary>>):

    Information about the runs of a workflow.

• On failure, responds with SdkError<ListWorkflowRunsError>

impl Client

pub fn list_workflows(&self) -> ListWorkflowsFluentBuilder

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

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

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

    The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

    
    
  • sort_by(WorkflowSortCriteria) / set_sort_by(Option<Vec::<WorkflowSortCriteria>>):
    required: false
    

    Information used to sort the items in the returned list.

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

    A token returned from a call to this API to indicate the next batch of results to return, if any.

  • items(Option<Vec::<WorkflowSummary>>):

    Information about the workflows in a project.

• On failure, responds with SdkError<ListWorkflowsError>

impl Client

pub fn start_dev_environment(&self) -> StartDevEnvironmentFluentBuilder

Constructs a fluent builder for the StartDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment.

    
    
  • ides(IdeConfiguration) / set_ides(Option<Vec::<IdeConfiguration>>):
    required: false
    

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    
    
  • instance_type(InstanceType) / set_instance_type(Option<InstanceType>):
    required: false
    

    The Amazon EC2 instace type to use for the Dev Environment.

    
    
  • inactivity_timeout_minutes(i32) / set_inactivity_timeout_minutes(Option<i32>):
    required: false
    

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

    
    
• On success, responds with StartDevEnvironmentOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

  • status(DevEnvironmentStatus):

    The status of the Dev Environment.

• On failure, responds with SdkError<StartDevEnvironmentError>

impl Client

pub fn start_dev_environment_session( &self ) -> StartDevEnvironmentSessionFluentBuilder

Constructs a fluent builder for the StartDevEnvironmentSession operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment.

    
    
  • session_configuration(DevEnvironmentSessionConfiguration) / set_session_configuration(Option<DevEnvironmentSessionConfiguration>):
    required: true
    

    Information about the configuration of a Dev Environment session.

    
    
• On success, responds with StartDevEnvironmentSessionOutput with field(s):
  • access_details(Option<DevEnvironmentAccessDetails>):

    Information about connection details for a Dev Environment.

  • session_id(Option<String>):

    The system-generated unique ID of the Dev Environment session.

  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

• On failure, responds with SdkError<StartDevEnvironmentSessionError>

impl Client

pub fn start_workflow_run(&self) -> StartWorkflowRunFluentBuilder

Constructs a fluent builder for the StartWorkflowRun operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • workflow_id(impl Into<String>) / set_workflow_id(Option<String>):
    required: true
    

    The system-generated unique ID of the workflow. To retrieve a list of workflow IDs, use ListWorkflows.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    
    
• On success, responds with StartWorkflowRunOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the workflow run.

  • workflow_id(String):

    The system-generated unique ID of the workflow.

• On failure, responds with SdkError<StartWorkflowRunError>

impl Client

pub fn stop_dev_environment(&self) -> StopDevEnvironmentFluentBuilder

Constructs a fluent builder for the StopDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment.

    
    
• On success, responds with StopDevEnvironmentOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

  • status(DevEnvironmentStatus):

    The status of the Dev Environment.

• On failure, responds with SdkError<StopDevEnvironmentError>

impl Client

pub fn stop_dev_environment_session( &self ) -> StopDevEnvironmentSessionFluentBuilder

Constructs a fluent builder for the StopDevEnvironmentSession operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment. To obtain this ID, use ListDevEnvironments.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment session. This ID is returned by StartDevEnvironmentSession.

    
    
• On success, responds with StopDevEnvironmentSessionOutput with field(s):
  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • id(String):

    The system-generated unique ID of the Dev Environment.

  • session_id(String):

    The system-generated unique ID of the Dev Environment session.

• On failure, responds with SdkError<StopDevEnvironmentSessionError>

impl Client

pub fn update_dev_environment(&self) -> UpdateDevEnvironmentFluentBuilder

Constructs a fluent builder for the UpdateDevEnvironment operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • project_name(impl Into<String>) / set_project_name(Option<String>):
    required: true
    

    The name of the project in the space.

    
    
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The system-generated unique ID of the Dev Environment.

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: false
    

    The user-specified alias for the Dev Environment. Changing this value will not cause a restart.

    
    
  • ides(IdeConfiguration) / set_ides(Option<Vec::<IdeConfiguration>>):
    required: false
    

    Information about the integrated development environment (IDE) configured for a Dev Environment.

    
    
  • instance_type(InstanceType) / set_instance_type(Option<InstanceType>):
    required: false
    

    The Amazon EC2 instace type to use for the Dev Environment.

    Changing this value will cause a restart of the Dev Environment if it is running.

    
    
  • inactivity_timeout_minutes(i32) / set_inactivity_timeout_minutes(Option<i32>):
    required: false
    

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

    Changing this value will cause a restart of the Dev Environment if it is running.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

    
    
• On success, responds with UpdateDevEnvironmentOutput with field(s):
  • id(String):

    The system-generated unique ID of the Dev Environment.

  • space_name(String):

    The name of the space.

  • project_name(String):

    The name of the project in the space.

  • alias(Option<String>):

    The user-specified alias for the Dev Environment.

  • ides(Option<Vec::<IdeConfiguration>>):

    Information about the integrated development environment (IDE) configured for the Dev Environment.

  • instance_type(Option<InstanceType>):

    The Amazon EC2 instace type to use for the Dev Environment.

  • inactivity_timeout_minutes(i32):

    The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

  • client_token(Option<String>):

    A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect.

• On failure, responds with SdkError<UpdateDevEnvironmentError>

impl Client

pub fn update_project(&self) -> UpdateProjectFluentBuilder

Constructs a fluent builder for the UpdateProject operation.

• The fluent builder is configurable:
  • space_name(impl Into<String>) / set_space_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the project.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the project.

    
    
• On success, responds with UpdateProjectOutput with field(s):
  • space_name(Option<String>):

    The name of the space.

  • name(Option<String>):

    The name of the project.

  • display_name(Option<String>):

    The friendly name of the project displayed to users in Amazon CodeCatalyst.

  • description(Option<String>):

    The description of the project.

• On failure, responds with SdkError<UpdateProjectError>

impl Client

pub fn update_space(&self) -> UpdateSpaceFluentBuilder

Constructs a fluent builder for the UpdateSpace operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the space.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the space.

    
    
• On success, responds with UpdateSpaceOutput with field(s):
  • name(Option<String>):

    The name of the space.

  • display_name(Option<String>):

    The friendly name of the space displayed to users in Amazon CodeCatalyst.

  • description(Option<String>):

    The description of the space.

• On failure, responds with SdkError<UpdateSpaceError>

impl Client

pub fn verify_session(&self) -> VerifySessionFluentBuilder

Constructs a fluent builder for the VerifySession operation.

• The fluent builder takes no input, just send it.
• On success, responds with VerifySessionOutput with field(s):
  • identity(Option<String>):

    The system-generated unique ID of the user in Amazon CodeCatalyst.

• On failure, responds with SdkError<VerifySessionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.