describe_tags `async` ¶

describe_tags(
    file_system_id: FileSystemId,
    *,
    config_overrides: Optional[AsyncEFSClientConfig] = None,
    max_items: Optional[MaxItems] = None,
    marker: Optional[Marker] = None,
) -> DescribeTagsResponse

DEPRECATED - The DescribeTags action is deprecated and not maintained. To view tags associated with EFS resources, use the ListTagsForResource API action.

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

Parameters:

max_items (Optional[MaxItems], default: None ) –

(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
marker (Optional[Marker], default: None ) –

(Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.
file_system_id (FileSystemId) –

The ID of the file system whose tag set you want to retrieve.

Raises:

BadRequest –

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
FileSystemNotFound –

Returned if the specified FileSystemId value doesn't exist in the requester's Amazon Web Services account.
InternalServerError –

Returned if an error occurred on the server side.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To describe the tags for a file system This operation describes all of a file system's tags.

>>> await client.describe_tags(file_system_id='fs-01234567')

Source code in docs_src/capo_efs/_services/async_efs.py

async def describe_tags(
    self,
    file_system_id: "capo_efs.types.file_system_id.FileSystemId",
    *,
    config_overrides: Optional[AsyncEFSClientConfig] = None,
    max_items: Optional["capo_efs.types.max_items.MaxItems"] = None,
    marker: Optional["capo_efs.types.marker.Marker"] = None,
) -> "capo_efs.types.describe_tags_response.DescribeTagsResponse":
    """<note> <p>DEPRECATED - The <code>DescribeTags</code> action is deprecated and not maintained. To view tags associated with EFS resources, use the <code>ListTagsForResource</code> API action.</p> </note> <p>Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. </p> <p> This operation requires permissions for the <code>elasticfilesystem:DescribeTags</code> action. </p>

    Args:
        max_items: <p>(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.</p>
        marker: <p>(Optional) An opaque pagination token returned from a previous <code>DescribeTags</code> operation (String). If present, it specifies to continue the list from where the previous call left off.</p>
        file_system_id: <p>The ID of the file system whose tag set you want to retrieve.</p>

    Raises:
        capo_efs.errors.bad_request.BadRequest: <p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
        capo_efs.errors.file_system_not_found.FileSystemNotFound: <p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's Amazon Web Services account.</p>
        capo_efs.errors.internal_server_error.InternalServerError: <p>Returned if an error occurred on the server side.</p>
        capo_efs.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe the tags for a file system
        This operation describes all of a file system's tags.

        >>> await client.describe_tags(file_system_id='fs-01234567')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_efs.types.describe_tags_request.DescribeTagsRequest]",
    ) -> AsyncOperationResponse[
        "capo_efs.types.describe_tags_response.DescribeTagsResponse"
    ]:
        import capo_efs._operations.magnolio_api_service_v20150201.describe_tags

        (
            output,
            http_response,
        ) = await capo_efs._operations.magnolio_api_service_v20150201.describe_tags.async_describe_tags(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTags")
    )
    input_: capo_efs.types.describe_tags_request.DescribeTagsRequest = {
        "file_system_id": file_system_id
    }
    if max_items is not None:
        input_["max_items"] = max_items
    if marker is not None:
        input_["marker"] = marker

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

describe_tags async ¶

describe_tags `async` ¶