Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.
Parameters:
-
sync_type
(SyncConfigurationType)
–
The sync type for the sync configuration for which you want to retrieve information.
-
resource_name
(ResourceName)
–
The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.
Raises:
Source code in docs_src/capo_codestar_connections/_services/code_starconnections.py
| def get_sync_configuration(
self,
sync_type: "capo_codestar_connections.types.sync_configuration_type.SyncConfigurationType",
resource_name: "capo_codestar_connections.types.resource_name.ResourceName",
*,
config_overrides: Optional[CodeStarconnectionsClientConfig] = None,
) -> "capo_codestar_connections.types.get_sync_configuration_output.GetSyncConfigurationOutput":
"""<p>Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.</p>
Args:
sync_type: <p>The sync type for the sync configuration for which you want to retrieve information.</p>
resource_name: <p>The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.</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.
"""
def _handler(
req: "OperationRequest[capo_codestar_connections.types.get_sync_configuration_input.GetSyncConfigurationInput]",
) -> OperationResponse[
"capo_codestar_connections.types.get_sync_configuration_output.GetSyncConfigurationOutput"
]:
import capo_codestar_connections._operations.code_star_connections_20191201.get_sync_configuration
output, http_response = (
capo_codestar_connections._operations.code_star_connections_20191201.get_sync_configuration.get_sync_configuration(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetSyncConfiguration")
)
input_: capo_codestar_connections.types.get_sync_configuration_input.GetSyncConfigurationInput = {
"sync_type": sync_type,
"resource_name": resource_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|