Skip to content

list_sync_configurations async

list_sync_configurations(
    repository_link_id: RepositoryLinkId,
    sync_type: SyncConfigurationType,
    *,
    config_overrides: Optional[AsyncCodeStarconnectionsClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[SharpNextToken] = None,
) -> ListSyncConfigurationsOutput

Returns a list of sync configurations for a specified repository.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

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

  • next_token (Optional[SharpNextToken], default: None ) –

    An enumeration token that allows the operation to batch the results of the operation.

  • repository_link_id (RepositoryLinkId) –

    The ID of the repository link for the requested list of sync configurations.

  • sync_type (SyncConfigurationType) –

    The sync type for the requested list of sync configurations.

Raises:

Source code in docs_src/capo_codestar_connections/_services/async_code_starconnections.py
async def list_sync_configurations(
    self,
    repository_link_id: "capo_codestar_connections.types.repository_link_id.RepositoryLinkId",
    sync_type: "capo_codestar_connections.types.sync_configuration_type.SyncConfigurationType",
    *,
    config_overrides: Optional[AsyncCodeStarconnectionsClientConfig] = None,
    max_results: Optional[
        "capo_codestar_connections.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_codestar_connections.types.sharp_next_token.SharpNextToken"
    ] = None,
) -> "capo_codestar_connections.types.list_sync_configurations_output.ListSyncConfigurationsOutput":
    """<p>Returns a list of sync configurations for a specified repository.</p>

    Args:
        max_results: <p>A non-zero, non-negative integer used to limit the number of returned results.</p>
        next_token: <p>An enumeration token that allows the operation to batch the results of the operation.</p>
        repository_link_id: <p>The ID of the repository link for the requested list of sync configurations.</p>
        sync_type: <p>The sync type for the requested list of sync configurations.</p>

    Raises:
        capo_codestar_connections.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_codestar_connections.errors.internal_server_exception.InternalServerException: <p>Received an internal server exception. Try again later.</p>
        capo_codestar_connections.errors.invalid_input_exception.InvalidInputException: <p>The input is not valid. Verify that the action is typed correctly.</p>
        capo_codestar_connections.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found. Verify the connection resource ARN and try again.</p>
        capo_codestar_connections.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codestar_connections.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codestar_connections.types.list_sync_configurations_input.ListSyncConfigurationsInput]",
    ) -> AsyncOperationResponse[
        "capo_codestar_connections.types.list_sync_configurations_output.ListSyncConfigurationsOutput"
    ]:
        import capo_codestar_connections._operations.code_star_connections_20191201.list_sync_configurations

        (
            output,
            http_response,
        ) = await capo_codestar_connections._operations.code_star_connections_20191201.list_sync_configurations.async_list_sync_configurations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSyncConfigurations")
    )
    input_: capo_codestar_connections.types.list_sync_configurations_input.ListSyncConfigurationsInput = {
        "repository_link_id": repository_link_id,
        "sync_type": sync_type,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output