Struct aws_sdk_codepipeline::client::fluent_builders::PollForJobs

pub struct PollForJobs<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to PollForJobs.

Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error.

When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

Implementations

impl<C, M, R> PollForJobs<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<PollForJobsOutput, SdkError<PollForJobsError>> where
    R::Policy: SmithyRetryPolicy<PollForJobsInputOperationOutputAlias, PollForJobsOutput, PollForJobsError, PollForJobsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn action_type_id(self, inp: ActionTypeId) -> Self

Represents information about an action type.

pub fn set_action_type_id(self, input: Option<ActionTypeId>) -> Self

Represents information about an action type.

pub fn max_batch_size(self, inp: i32) -> Self

The maximum number of jobs to return in a poll for jobs call.

pub fn set_max_batch_size(self, input: Option<i32>) -> Self

The maximum number of jobs to return in a poll for jobs call.

pub fn query_param(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to queryParam.

To override the contents of this collection use set_query_param.

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

pub fn set_query_param(self, input: Option<HashMap<String, String>>) -> Self

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for PollForJobs<C, M, R>

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

Formats the value using the given formatter.